migration

README

Migration

Simple and pragmatic migrations for Go applications.

Features

• Super simple driver interface to allow easy implementation for more database/migration drivers.
• Embeddable migration files.
• Support for up/down migrations.
• Atomic migrations (where possible, depending on database support).
• Support for using Go code as migrations

Drivers

• Apache Phoenix
• Golang (runs generic go functions)
• MySQL
• PostgreSQL
• SQLite

Quickstart

// Create migration source
packrSource := &migration.PackrMigrationSource{
    Box: packr.NewBox("migrations"),
}

// Create driver
driver, err := phoenix.New("http://localhost:8765")

// Run all up migrations
applied, err := Migrate(driver, packrSource, migration.Up, 0)

// Remove the last 2 migrations
applied, err := Migrate(driver, packrSource, migration.Down, 2)

Writing migrations

Migrations are extremely simple to write:

• Separate your up and down migrations into different files. For example, 1_init.up.sql and 1_init.down.sql.
• Prefix your migration with a number or timestamp for versioning: 1_init.up.sql or 1475813115_init.up.sql.
• The file-extension can be anything you want, but must be present. For example, 1_init.up.sql is valid, but 1_init.up is not,
• Note: Underscores (_) must be used to separate the number and description in the filename.

Let's say we want to write our first migration to initialize the database.

In that case, we would have a file called 1_init.up.sql containing SQL statements for the up migration:

CREATE TABLE test_data (
  id BIGINT NOT NULL PRIMARY KEY,
)

We also create a 1_init.down.sql file containing SQL statements for the down migration:

DROP TABLE IF EXISTS test_data

By default, migrations are run within a transaction. If you do not want a migration to run within a transaction, start the migration file with -- +migration NoTransaction:

-- +migration NoTransaction

CREATE TABLE test_data1 (
  id BIGINT NOT NULL PRIMARY KEY,
)

CREATE TABLE test_data2 (
  id BIGINT NOT NULL PRIMARY KEY,
)

If you would like to create stored procedures, triggers or complex statements that contain semicolns, use BeginStatement and EndStatement to delineate them:

CREATE TABLE test_data1 (
  id BIGINT NOT NULL PRIMARY KEY,
)

CREATE TABLE test_data2 (
  id BIGINT NOT NULL PRIMARY KEY,
)

-- +migration BeginStatement
CREATE TRIGGER`test_trigger_1`BEFORE UPDATE ON`test_data1`FOR EACH ROW BEGIN
		INSERT INTO test_data2
		SET id = OLD.id;
END
-- +migration EndStatement

Embedding migration files

Using packr

Assuming your migration files are in migrations/, initialize a PackrMigrationSource:

packrSource := &migration.PackrMigrationSource{
	Box: packr.NewBox("migrations"),
}

If your migrations are contained in a subdirectory inside your packr box, you can point to it using the Dir property:

packrSource := &migration.PackrMigrationSource{
	Box: packr.NewBox("."),
	Dir: "migrations",
}

During development, packr will read the migration files from disk. When building for production, run packr to generate a Go file containing your migrations, or use packr build to build for your binary. For more information, see the packr documenation.

Using go-bindata

Note: We recommend using packr as it allows you to use migrations from disk during development

In the simplest case, assuming your migration files are in migrations/, just run:

go-bindata -o bindata.go -pkg myapp migrations/

Then, use GoBindataMigrationSource to find the migrations:

goBindataSource := &migration.GoBindataMigrationSource{
    Asset:    Asset,
    AssetDir: AssetDir,
    Dir:      "test-migrations",
}

The Asset and AssetDir functions are generated by go-bindata.

Using Go for migrations

Sometimes, we might be working with a database or have a situation where the query language is not expressive enough to perform the required migrations. For example, we might have to get some data out of the database, perform some transformations and then write it back. For these type of situations, you can use Go for migrations.

When using Go for migrations, create a golang.Source using golang.NewSource(). Then, simply add migrations to the source using the AddMigration() method. You will need to pass in the name of the migration without the extension and direction, e.g. 1_init. For the second parameter, pass in the direction (migration.Up or migration.Down) and for the third parameter, pass in a function or method with this signature: func(c *golangConfig) error for running the migration.

If your migrations need to access configuration values or database clients, create a golang.Config struct using golang.NewConfig(). This is concurrency-safe, and you can set values into it using Set() and retrieve values using Get().

Finally, you need to define 2 functions:

• A function for writing or deleting an applied migration matching this signature: func(config *golang.Config, id string, direction migration.Direction) error
• A function for getting a list of applied migrations matching this signature: func(config *golang.Config) ([]string, error)

These are required for initializing the driver:

driver, err := golang.New(source, updateVersion, applied, config)

Here's a quick example:

source := golang.NewSource()

source.AddMigration("1_init", migration.Up, func(c *golang.Config) error {
    // Run up migration here
    
    // If required, you can retrieve configuration here: something := c.Get("something")
})

source.AddMigration("1_init", migration.Down, func(c *golang.Config) error {
    // Run down migration here
})

// Create config
config := golang.NewConfig()
config.Set("test", "test")

// Define functions
applied := func(c *golang.Config) ([]string, error) {
    // Return list of applied migrations
}

updateVersion := func(id string, direction migration.Direction, c *golangC.onfig) error {
    // Write or delete applied migration in storage
}

// Create driver
driver, err := golang.New(source, updateVersion, applied, config)

// Run migrations
count, err = migration.Migrate(driver, source, migration.Up, 0)

TODO (Pull requests welcomed!)

• Command line program to run migrations
• More drivers

Why yet another migration library?

We wanted a migration library with the following features:

• Open to extension for all sorts of databases, not just database/sql drivers or an ORM.
• Easily embeddable in a Go application.
• Support for embedding migration files directly into the app.

We narrowed our focus down to 2 contenders: sql-migrate and migrate

sql-migrate leans heavily on the gorp ORM library to perform migrations. Unfortunately, this means that we were restricted to databases supported by gorp. It is easily embeddable in a Go app and supports embedding migration files directly into the Go binary. If database support was a bit more flexible, we would have gone with it.

migrate is highly extensible, and adding support for another database is extremely trivial. However, due to it using the scheme in the dsn to determine which database driver to use, it prevented us from easily implementing an Apache Phoenix driver, which uses the scheme to determine if we should connect over http or https. Due to the way the project is structured, it was also almost impossible to add support for embeddable migration files without major changes.

License

This library is licensed under the Apache 2 License.

Documentation

Index

• func Migrate(driver Driver, migrations Source, direction Direction, max int) (int, error)
• type Direction
• type Driver
• type GoBindataMigrationSource
  • func (a GoBindataMigrationSource) GetMigrationFile(name string) (io.Reader, error)
  • func (a GoBindataMigrationSource) ListMigrationFiles() ([]string, error)
• type MemoryMigrationSource
  • func (m MemoryMigrationSource) GetMigrationFile(name string) (io.Reader, error)
  • func (m MemoryMigrationSource) ListMigrationFiles() ([]string, error)
• type Migration
  • func (m Migration) Less(other *Migration) bool
  • func (m Migration) NumberPrefixMatches() []string
  • func (m Migration) VersionInt() int64
• type PackrBox
• type PackrMigrationSource
  • func (p PackrMigrationSource) GetMigrationFile(name string) (io.Reader, error)
  • func (p PackrMigrationSource) ListMigrationFiles() ([]string, error)
• type PlannedMigration
• type Source

Functions

func Migrate

func Migrate(driver Driver, migrations Source, direction Direction, max int) (int, error)

Migrate runs a migration using a given driver and MigrationSource. The direction defines whether the migration is up or down, and max is the maximum number of migrations to apply. If max is set to 0, then there is no limit on the number of migrations to apply.

Types

type Direction

type Direction int

const (
	Up Direction = iota
	Down
)

type Driver

type Driver interface {
	// Close is the last function to be called.
	// Close any open connection here.
	Close() error

	// Migrate is the heart of the driver.
	// It will receive a PlannedMigration which the driver should apply
	// to its backend or whatever.
	Migrate(migration *PlannedMigration) error

	// Version returns all applied migration versions
	Versions() ([]string, error)
}

Driver is the interface type that needs to implemented by all drivers.

type GoBindataMigrationSource

type GoBindataMigrationSource struct {
	// Asset should return content of file in path if exists
	Asset func(path string) ([]byte, error)

	// AssetDir should return list of files in the path
	AssetDir func(path string) ([]string, error)

	// Path in the bindata to use.
	Dir string
}

GoBindataMigrationSource is a MigrationSource that uses migration files embedded in a Go application using go-bindata.

func (GoBindataMigrationSource) GetMigrationFile

func (a GoBindataMigrationSource) GetMigrationFile(name string) (io.Reader, error)

func (GoBindataMigrationSource) ListMigrationFiles

func (a GoBindataMigrationSource) ListMigrationFiles() ([]string, error)

type MemoryMigrationSource

type MemoryMigrationSource struct {
	Files map[string]string
}

MemoryMigrationSource is a MigrationSource that uses migration sources in memory. It is mainly used for testing.

func (MemoryMigrationSource) GetMigrationFile

func (m MemoryMigrationSource) GetMigrationFile(name string) (io.Reader, error)

func (MemoryMigrationSource) ListMigrationFiles

func (m MemoryMigrationSource) ListMigrationFiles() ([]string, error)

type Migration

type Migration struct {
	ID   string
	Up   *parser.ParsedMigration
	Down *parser.ParsedMigration
}

Migration represents a migration, containing statements for migrating up and down.

func (Migration) Less

func (m Migration) Less(other *Migration) bool

Less compares two migrations to determine how they should be ordered.

func (Migration) NumberPrefixMatches

func (m Migration) NumberPrefixMatches() []string

func (Migration) VersionInt

func (m Migration) VersionInt() int64

VersionInt converts the migration version to an 64-bit integer.

type PackrBox

type PackrBox interface {
	List() []string
	Bytes(name string) []byte
}

Avoids pulling in the packr library for everyone, mimicks the bits of packr.Box that we need.

type PackrMigrationSource

type PackrMigrationSource struct {
	Box PackrBox

	// The path in the packr box to use
	Dir string
}

func (PackrMigrationSource) GetMigrationFile

func (p PackrMigrationSource) GetMigrationFile(name string) (io.Reader, error)

func (PackrMigrationSource) ListMigrationFiles

func (p PackrMigrationSource) ListMigrationFiles() ([]string, error)

type PlannedMigration

type PlannedMigration struct {
	*Migration
	Direction Direction
}

PlannedMigration is a migration with a direction defined. This allows the driver to work out how to apply the migration.

type Source

type Source interface {
	ListMigrationFiles() ([]string, error)
	GetMigrationFile(file string) (io.Reader, error)
}

Source is an interface that defines how a source can find and read migration files.