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"
)
Database drivers are responsible for applying migrations to databases. Implementing a new database driver is easy. Just implement database/driver interface
Source Drivers read migrations from various locations. Implementing a new source driver is easy. Just implement the source/driver interface.
- Filesystem - read from fileystem (always included)
- Go-Bindata - read from embedded binary data (jteeuwen/go-bindata)
- Github - read from remote Github repositories
- AWS S3 - read from Amazon Web Services S3
- Google Cloud Storage - read from Google Cloud Platform Storage
# 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
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)
}Each migration version has an up and down migration.
1481574547_create_users_table.up.sql
1481574547_create_users_table.down.sql
- Make sure you have a running Docker daemon (Install for MacOS)
- Fork this repo and
git clonesomewhere to$GOPATH/src/github.com/%you%/migrate make rewrite-import-pathsto update imports to your local fork- Confirm tests are working:
make test-short - Write awesome code ...
make testto run all tests against all database versionsmake restore-import-pathsto restore import paths- 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, runmake html-coveragewhich opens a shiny test coverage overview. - Missing imports?
make deps make build-clibuilds the CLI in directorycli/build/.make list-external-depslists all external dependencies for each package
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent