mirror of https://github.com/status-im/migrate.git
140 lines
5.0 KiB
Markdown
140 lines
5.0 KiB
Markdown
[](https://travis-ci.org/mattes/migrate)
|
|
[](https://godoc.org/github.com/mattes/migrate)
|
|
[](https://coveralls.io/github/mattes/migrate?branch=v3.0-prev)
|
|
[](https://packagecloud.io/mattes/migrate?filter=debs)
|
|
|
|
# migrate
|
|
|
|
__Database migrations written in Go. Use as [CLI](#cli-usage) or import as [library](#use-in-your-go-project).__
|
|
|
|
* Migrate reads migrations from [sources](#migration-sources)
|
|
and applies them in correct order to a [database](#databases).
|
|
* Drivers are "dumb", migrate glues everything together and makes sure the logic is bulletproof.
|
|
(Keeps the drivers lightweight, too.)
|
|
* Database drivers don't assume things or try to correct user input. When in doubt, fail.
|
|
|
|
|
|
|
|
## Databases
|
|
|
|
Database drivers run migrations. [Add a new database?](database/driver.go)
|
|
|
|
* [PostgreSQL](database/postgres)
|
|
* [Cassandra](database/cassandra) ([todo #164](https://github.com/mattes/migrate/issues/164))
|
|
* [SQLite](database/sqlite) ([todo #165](https://github.com/mattes/migrate/issues/165))
|
|
* [MySQL/ MariaDB](database/mysql) ([todo #166](https://github.com/mattes/migrate/issues/166))
|
|
* [Neo4j](database/neo4j) ([todo #167](https://github.com/mattes/migrate/issues/167))
|
|
* [Ql](database/ql) ([todo #168](https://github.com/mattes/migrate/issues/168))
|
|
* [MongoDB](database/mongodb) ([todo #169](https://github.com/mattes/migrate/issues/169))
|
|
* [CrateDB](database/crate) ([todo #170](https://github.com/mattes/migrate/issues/170))
|
|
* [Shell](database/shell) ([todo #171](https://github.com/mattes/migrate/issues/171))
|
|
* [Google Cloud Spanner](database/spanner) ([todo #172](https://github.com/mattes/migrate/issues/172))
|
|
|
|
|
|
|
|
## Migration Sources
|
|
|
|
Source drivers read migrations from local or remote sources. [Add a new source?](source/driver.go)
|
|
|
|
* [Filesystem](source/file) - read from fileystem (always included)
|
|
* [Go-Bindata](source/go-bindata) - read from embedded binary data ([jteeuwen/go-bindata](https://github.com/jteeuwen/go-bindata))
|
|
* [Github](source/github) - read from remote Github repositories
|
|
* [AWS S3](source/aws-s3) - read from Amazon Web Services S3 ([todo #162](https://github.com/mattes/migrate/issues/162))
|
|
* [Google Cloud Storage](source/google-cloud-storage) - read from Google Cloud Platform Storage ([todo #163](https://github.com/mattes/migrate/issues/163))
|
|
|
|
|
|
|
|
## CLI usage
|
|
|
|
* Simple wrapper around this library.
|
|
* Handles ctrl+c (SIGINT) gracefully.
|
|
* No config search paths, no config files, no magic ENV var injections.
|
|
|
|
__[CLI Documentation](cli)__
|
|
|
|
([brew todo #156](https://github.com/mattes/migrate/issues/156))
|
|
|
|
```
|
|
$ brew install migrate --with-postgres
|
|
$ migrate -database postgres://localhost:5432/database up 2
|
|
```
|
|
|
|
|
|
## Use in your Go project
|
|
|
|
* API is stable and frozen for this release (v3.x).
|
|
* Package migrate has no external dependencies.
|
|
* Only import the drivers you need.
|
|
(check [dependency_tree.txt](https://github.com/mattes/migrate/releases) for each driver)
|
|
* To help prevent database corruptions, it supports graceful stops via `GracefulStop chan bool`.
|
|
* Bring your own logger.
|
|
* Uses `io.Reader` streams internally for low memory overhead.
|
|
* Thread-safe and no goroutine leaks.
|
|
|
|
__[Go Documentation](https://godoc.org/github.com/mattes/migrate)__
|
|
|
|
```go
|
|
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)
|
|
}
|
|
```
|
|
|
|
Want to use an existing database client?
|
|
|
|
```go
|
|
import (
|
|
"database/sql"
|
|
_ "github.com/lib/pq"
|
|
"github.com/mattes/migrate/migrate"
|
|
"github.com/mattes/migrate/database/postgres"
|
|
)
|
|
|
|
func main() {
|
|
db, err := sql.Open("postgres", "postgres://localhost:5432/database?sslmode=enable")
|
|
driver, err := postgres.WithInstance(db, &postgres.Config{})
|
|
m, err := migrate.NewWithDatabaseInstance(
|
|
"file:///migrations",
|
|
"postgres", driver)
|
|
m.Steps(2)
|
|
}
|
|
```
|
|
|
|
## Migration files
|
|
|
|
Each migration has an up and down migration. [Why?](FAQ.md#why-two-separate-files-up-and-down-for-a-migration)
|
|
|
|
```
|
|
1481574547_create_users_table.up.sql
|
|
1481574547_create_users_table.down.sql
|
|
```
|
|
|
|
[Best practices: How to write migrations.](MIGRATIONS.md)
|
|
|
|
|
|
|
|
## Development and Contributing
|
|
|
|
Yes, please! [`Makefile`](Makefile) is your friend,
|
|
read the [development guide](CONTRIBUTING.md).
|
|
|
|
Also have a look at the [FAQ](FAQ.md).
|
|
|
|
|
|
|
|
---
|
|
|
|
__Alternatives__
|
|
|
|
https://bitbucket.org/liamstask/goose, https://github.com/tanel/dbmigrate,
|
|
https://github.com/BurntSushi/migration, https://github.com/DavidHuie/gomigrate,
|
|
https://github.com/rubenv/sql-migrate
|