Database migrations. CLI and Golang library.
Go to file
Matthias Kadenbach 8ba71b0754 rename nameFromUrl to schemeFromUrl 2017-02-09 18:19:13 -08:00
cli initial version 3.0.0 preview 2017-02-07 22:01:29 -08:00
database fixing travis 2017-02-08 01:49:57 -08:00
migrate add code comments for package migrate 2017-02-09 16:59:30 -08:00
source add code comments for package migrate 2017-02-09 16:59:30 -08:00
testing fixing travis 2017-02-08 01:49:57 -08:00
.gitignore add .godoc.pid to gitignore 2017-02-09 13:47:28 -08:00
.travis.yml add make release 2017-02-08 19:54:50 -08:00
LICENSE initial version 3.0.0 preview 2017-02-07 22:01:29 -08:00
Makefile fix line break in makefile 2017-02-09 12:03:03 -08:00
README.md add make docs 2017-02-09 11:59:49 -08:00
log.go initial version 3.0.0 preview 2017-02-07 22:01:29 -08:00
migrate.go rename nameFromUrl to schemeFromUrl 2017-02-09 18:19:13 -08:00
migrate_test.go add Migrate.Run 2017-02-09 18:04:36 -08:00
migration.go rename Migration.LongString to LogString 2017-02-09 18:06:38 -08:00
migration_test.go rename Migration.LongString to LogString 2017-02-09 18:06:38 -08:00
util.go rename nameFromUrl to schemeFromUrl 2017-02-09 18:19:13 -08:00
util_test.go add test for suint 2017-02-09 18:16:16 -08:00

README.md

migrate

Build Status GoDoc Coverage Status

Database migrations written in Go. Use as CLI or import as library.

go get -u -tags 'postgres' -o migrate github.com/mattes/migrate/cli

import (
  "github.com/mattes/migrate"
  _ "github.com/mattes/migrate/database/postgres"
)

Databases

Database drivers are responsible for applying migrations to databases. Implementing a new database driver is easy. Just implement database/driver interface

Migration Sources

Source Drivers read migrations from various locations. Implementing a new source driver is easy. Just implement the source/driver interface.

CLI usage

# dowload, build and install the CLI tool
# -tags takes database and source drivers and will only build those
$ go get -u -tags 'postgres' -o migrate github.com/mattes/migrate/cli

$ migrate -help
Usage: migrate OPTIONS COMMAND [arg...]
       migrate [ -version | -help ]

Options:
  -source      Location of the migrations (driver://url)
  -path        Shorthand for -source=file://path
  -database    Run migrations against this database (driver://url)
  -prefetch N  Number of migrations to load in advance before executing (default 10)
  -verbose     Print verbose logging
  -version     Print version
  -help        Print usage

Commands:
  goto V       Migrate to version V
  up [N]       Apply all or N up migrations
  down [N]     Apply all or N down migrations
  drop         Drop everyting inside database
  version      Print current migration version


# so let's say you want to run the first two migrations
migrate -database postgres://localhost:5432/database up 2

# if your migrations are hosted on github
migrate -source github://mattes:personal-access-token@mattes/migrate_test \
  -database postgres://localhost:5432/database down 2

Use in your Go project

import (
  "github.com/mattes/migrate/migrate"
  _ "github.com/mattes/migrate/database/postgres"
  _ "github.com/mattes/migrate/source/github"
)

func main() {
  m, err := migrate.New("github://mattes:personal-access-token@mattes/migrate_test",
    "postgres://localhost:5432/database?sslmode=enable")
  m.Steps(2)
}

Migration files

Each migration version has an up and down migration.

1481574547_create_users_table.up.sql
1481574547_create_users_table.down.sql

Development, Testing and Contributing

  1. Make sure you have a running Docker daemon (Install for MacOS)
  2. Fork this repo and git clone somewhere to $GOPATH/src/github.com/%you%/migrate
  3. make rewrite-import-paths to update imports to your local fork
  4. Confirm tests are working: make test-short
  5. Write awesome code ...
  6. make test to run all tests against all database versions
  7. make restore-import-paths to restore import paths
  8. Push code and open Pull Request

Some more notes:

  • You can specify which database/ source tests to run:
    make test-short SOURCE='file go-bindata' DATABASE='postgres cassandra'
  • After make test, run make html-coverage which opens a shiny test coverage overview.
  • Missing imports? make deps
  • make build-cli builds the CLI in directory cli/build/.
  • make list-external-deps lists all external dependencies for each package
  • make docs && make open-docs opens godoc in your browser, make kill-docs kills the godoc server.
    Repeatedly call make docs to refresh the server.

Alternatives