migrate/cli
Harald Nordgren a6eddccfe5 Document that '-source' is a required parameter 2018-08-07 09:53:36 +02:00
..
examples Fork packagecloud releases 2018-01-20 02:10:22 -08:00
README.md Document that '-source' is a required parameter 2018-08-07 09:53:36 +02:00
build_aws-s3.go Rename sources to reflect updated build constraint names 2018-06-12 16:45:56 +08:00
build_cassandra.go Update imports to reference fork. 2018-01-19 10:56:55 -08:00
build_clickhouse.go Update imports to reference fork. 2018-01-19 10:56:55 -08:00
build_cockroachdb.go Update imports to reference fork. 2018-01-19 10:56:55 -08:00
build_github.go Update imports to reference fork. 2018-01-19 10:56:55 -08:00
build_go-bindata.go Rename sources to reflect updated build constraint names 2018-06-12 16:45:56 +08:00
build_godoc-vfs.go Fix broken CLI build 2018-06-17 23:16:38 -07:00
build_google-cloud-storage.go Rename sources to reflect updated build constraint names 2018-06-12 16:45:56 +08:00
build_mysql.go Update imports to reference fork. 2018-01-19 10:56:55 -08:00
build_postgres.go Update imports to reference fork. 2018-01-19 10:56:55 -08:00
build_ql.go Update imports to reference fork. 2018-01-19 10:56:55 -08:00
build_redshift.go Update imports to reference fork. 2018-01-19 10:56:55 -08:00
build_spanner.go Update imports to reference fork. 2018-01-19 10:56:55 -08:00
build_sqlite3.go Update imports to reference fork. 2018-01-19 10:56:55 -08:00
commands.go Fix time format flag to be backwards compatible 2018-06-18 00:06:17 -07:00
commands_test.go Support creating migrations using sequences in addition to timestamps 2018-01-20 00:29:06 -08:00
log.go initial version 3.0.0 preview 2017-02-07 22:01:29 -08:00
main.go Fix time format flag to be backwards compatible 2018-06-18 00:06:17 -07:00
version.go initial version 3.0.0 preview 2017-02-07 22:01:29 -08:00

README.md

migrate CLI

Installation

Download pre-build binary (Windows, MacOS, or Linux)

Release Downloads

$ curl -L https://github.com/golang-migrate/migrate/releases/download/$version/migrate.$platform-amd64.tar.gz | tar xvz

MacOS

We have not released support for homebrew yet, but there is a live issue here: todo #156

Any help to make this happen would be appreciated!

Linux (*.deb package)

$ curl -L https://packagecloud.io/golang-migrate/migrate/gpgkey | apt-key add -
$ echo "deb https://packagecloud.io/golang-migrate/migrate/ubuntu/ xenial main" > /etc/apt/sources.list.d/migrate.list
$ apt-get update
$ apt-get install -y migrate

With Go toolchain

$ go get -u -d github.com/golang-migrate/migrate/cli
$ cd $GOPATH/src/github.com/golang-migrate/migrate/cli
$ dep ensure
$ go build -tags 'postgres' -o /usr/local/bin/migrate github.com/golang-migrate/migrate/cli
Notes:
  1. This example builds the cli which will only work with postgres. In order to build the cli for use with other databases, replace the postgres build tag with the appropriate database tag(s) for the databases desired. The tags correspond to the names of the sub-packages underneath the database package.
  2. Similarly to the database build tags, if you need to support other sources, use the appropriate build tag(s).
  3. Support for build constraints will be removed in the future: https://github.com/golang-migrate/migrate/issues/60

Usage

$ 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)
  -lock-timeout N  Allow N seconds to acquire database lock (default 15)
  -verbose         Print verbose logging
  -version         Print version
  -help            Print usage

Commands:
  create [-ext E] [-dir D] [-seq] [-digits N] [-format] NAME
               Create a set of timestamped up/down migrations titled NAME, in directory D with extension E.
               Use -seq option to generate sequential up/down migrations with N digits.
               Use -format option to specify a Go time format string.
  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
  force V      Set version V but don't run migration (ignores dirty state)
  version      Print current migration version

So let's say you want to run the first two migrations

$ migrate -source file://path/to/migrations -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

The CLI will gracefully stop at a safe point when SIGINT (ctrl+c) is received. Send SIGKILL for immediate halt.

Reading CLI arguments from somewhere else

ENV variables
$ migrate -database "$MY_MIGRATE_DATABASE"
JSON files

Check out https://stedolan.github.io/jq/

$ migrate -database "$(cat config.json | jq '.database')"
YAML files
$ migrate -database "$(cat config/database.yml | ruby -ryaml -e "print YAML.load(STDIN.read)['database']")"
$ migrate -database "$(cat config/database.yml | python -c 'import yaml,sys;print yaml.safe_load(sys.stdin)["database"]')"
```