migrate

Documentation

Overview

Package migrate manage DB migrations.

Index

• Variables
• func MySQLUpDownTest(t *check.C, ctx Ctx, goose *goosepkg.Instance, dir string, cfg *mysql.Config)
• func PostgresUpDownTest(t *check.C, ctx Ctx, goose *goosepkg.Instance, dir string, ...)
• func Run(ctx Ctx, goose *goosepkg.Instance, dir string, command string, c Connector) error
• func UpTo(ctx Ctx, goose *goosepkg.Instance, dir string, version int64, c Connector) (*schemaver.SchemaVer, error)
• type Connector
• type Ctx
• type MySQL
  • func (c *MySQL) Connect(ctx Ctx, goose *goosepkg.Instance) (_ *sql.DB, _ *schemaver.SchemaVer, err error)
• type Postgres
  • func (c *Postgres) Connect(ctx Ctx, goose *goosepkg.Instance) (_ *sql.DB, _ *schemaver.SchemaVer, err error)

Variables

var ErrDownNotSupported = errors.New("downgrade is not supported, restore from backup instead")

ErrDownNotSupported must be returned from goose Down function in case this migration does not support downgrade.

Functions

func MySQLUpDownTest

func MySQLUpDownTest(t *check.C, ctx Ctx, goose *goosepkg.Instance, dir string, cfg *mysql.Config)

MySQLUpDownTest creates temporary database, test given migrations, and removes temporary database.

func PostgresUpDownTest

func PostgresUpDownTest(t *check.C, ctx Ctx, goose *goosepkg.Instance, dir string, cfg *def.PostgresConfig)

PostgresUpDownTest creates temporary database, test given migrations, and removes temporary database.

func Run

func Run(ctx Ctx, goose *goosepkg.Instance, dir string, command string, c Connector) error

Run executes goose command. It also enforce "fix" after "create".

func UpTo

func UpTo(ctx Ctx, goose *goosepkg.Instance, dir string, version int64, c Connector) (*schemaver.SchemaVer, error)

UpTo migrates up to a specific version.

Unlike goose.UpTo it will return error is current version doesn't match requested one after migration.

Types

type Connector

type Connector interface {
	Connect(Ctx, *goosepkg.Instance) (*sql.DB, *schemaver.SchemaVer, error)
}

Connector provides a way to connect to any database with schemaver.

type Ctx

type Ctx = context.Context

Ctx is a synonym for convenience.

type MySQL

type MySQL struct {
	*mysql.Config
}

MySQL implements Connector interface.

func (*MySQL) Connect

func (c *MySQL) Connect(ctx Ctx, goose *goosepkg.Instance) (_ *sql.DB, _ *schemaver.SchemaVer, err error)

Connect to MySQL. Will create database and initialize schemaver if needed.

type Postgres

type Postgres struct {
	*def.PostgresConfig
}

Postgres implements Connector interface.

func (*Postgres) Connect

func (c *Postgres) Connect(ctx Ctx, goose *goosepkg.Instance) (_ *sql.DB, _ *schemaver.SchemaVer, err error)

Connect to PostgreSQL. Will initialize schemaver if needed.