makoto

Simple migration tool for PostgreSQL

Install

Install makoto CLI

go get -u github.com/cororoGrap/makoto/cmd/makoto

Install makoto migrator

go get github.com/cororoGrap/makoto

Structure

makoto will create a directory named migration under your project. All sql migration sql will placed under this directory. Migration scripts should be named as

v[numeric version number]_[script name].sql
e.g.
v1_basic.sql

CLI

Init migration directory

makoto init

Create new migration sql script

makoto new [script_name]

Generate golang migration collection, a golang file 'collection.go' will be created under the migration directory

makoto collect

Check current migration status

makoto status

Migrate to latest version

makoto up

Database connection uri format

makoto -database postgres://[username]:[password]@[host]:5432/[dbname]?sslmode=[enable|disable] [command]

Custom config file

makoto -config [file path] [command]

If no custom config file or database uri is given, makoto will search for "config.json" placed inside migration directory

Config file format

{
  "database": "PostgreSQL",
  "PostgreSQL": {
    "Host": "localhost",
    "Port": "5432",
    "DBName": "xxx",
    "User": "postgres",
    "Password": "123456"
  }
}

Integrate with Golang

First generate the collection file with CLI.

Initialize the makoto migrator

migrator := makoto.New(db, "postgres") // pass the DB pointer and DB driver name

Pass the migration collection to migrator

migrator.SetCollection(migration.GetCollection())

Perform migration

migrator.Up() // migrate to latest version
// or
migrator.EnsureSchema("v10") // migrate to a given version

Example

func startMigration(db *sql.DB) {
    migrator := makoto.New(db, "postgres")
    migrator.SetCollection(migration.GetCollection())
    migrator.EnsureSchema("V2") 
}