2gis/migrate

Name: migrate

Owner: 2GIS

Description: Database migrations. CLI and Golang library.

Created: 2018-03-15 02:10:12.0

Updated: 2018-03-15 05:37:40.0

Pushed: 2018-03-15 05:37:38.0

Homepage:

Size: 488

Language: Go

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

migrate

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

• Migrate reads migrations from sources and applies them in correct order to a database.
• 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.

Looking for v1?

Databases

Database drivers run migrations. Add a new database?

• PostgreSQL
• Redshift
• Ql
• Cassandra
• SQLite
• MySQL/ MariaDB
• Neo4j (todo #167)
• MongoDB (todo #169)
• CrateDB (todo #170)
• Shell (todo #171)
• Google Cloud Spanner
• CockroachDB
• ClickHouse

Migration Sources

Source drivers read migrations from local or remote sources. Add a new source?

• Filesystem - read from fileystem
• 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

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

(brew todo #156)

ew install migrate --with-postgres
grate -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 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

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


 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?

rt (
"database/sql"
_ "github.com/lib/pq"
"github.com/mattes/migrate"
"github.com/mattes/migrate/database/postgres"
_ "github.com/mattes/migrate/source/file"


 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?

574547_create_users_table.up.sql
574547_create_users_table.down.sql

Best practices: How to write migrations.

Development and Contributing

Yes, please! Makefile is your friend, read the development guide.

Also have a look at the FAQ.

---

Looking for alternatives? https://awesome-go.com/#database.