This repository has been archived by the owner on Aug 2, 2023. It is now read-only.
forked from ninthclowd/migrate
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Move main CLI docs from cli to cmd/migrate
- Clean up markdown
- Update example CLI usage in Docker- Loading branch information
Showing
5 changed files
with
179 additions
and
179 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,125 +1,3 @@ | ||
| # migrate CLI | ||
| # Deprecated | ||
|
|
||
| ## Installation | ||
|
|
||
| #### Download pre-built binary (Windows, MacOS, or Linux) | ||
|
|
||
| [Release Downloads](https://github.com/golang-migrate/migrate/releases) | ||
|
|
||
| ``` | ||
| $ curl -L https://github.com/golang-migrate/migrate/releases/download/$version/migrate.$platform-amd64.tar.gz | tar xvz | ||
| ``` | ||
|
|
||
| #### MacOS | ||
|
|
||
| ``` | ||
| $ brew install golang-migrate | ||
| ``` | ||
|
|
||
| #### Linux (*.deb package) | ||
|
|
||
| ``` | ||
| $ curl -L https://packagecloud.io/golang-migrate/migrate/gpgkey | apt-key add - | ||
| $ echo "deb https://packagecloud.io/golang-migrate/migrate/ubuntu/ $(lsb_release -sc) main" > /etc/apt/sources.list.d/migrate.list | ||
| $ apt-get update | ||
| $ apt-get install -y migrate | ||
| ``` | ||
|
|
||
| #### With Go toolchain | ||
|
|
||
| ##### Unversioned | ||
| ``` | ||
| $ go get -tags 'postgres' -u github.com/golang-migrate/migrate/cmd/migrate | ||
| ``` | ||
|
|
||
| ##### Versioned | ||
|
|
||
| ``` | ||
| $ go get -u -d github.com/golang-migrate/migrate/cmd/migrate | ||
| $ cd $GOPATH/src/github.com/golang-migrate/migrate/cmd/migrate | ||
| $ git checkout $TAG # e.g. v4.1.0 | ||
| $ go build -tags 'postgres' -ldflags="-X main.Version=$(git describe --tags)" -o $GOPATH/bin/migrate github.com/golang-migrate/migrate/cmd/migrate | ||
| ``` | ||
|
|
||
| ##### Notes: | ||
| 1. Requires a version of Go that [supports modules](https://golang.org/cmd/go/#hdr-Preliminary_module_support). e.g. Go 1.11+ | ||
| 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`](../database) package. | ||
| 1. Similarly to the database build tags, if you need to support other sources, use the appropriate build tag(s). | ||
| 1. 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"]')" | ||
| ``` | ||
| Use [cmd/migrate](../cmd/migrate) instead |
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.