migrate

Documentation

Overview

Package migrate manage DB migrations.

Index

• Variables
• func Run(ctx Ctx, goose *goosepkg.Instance, dir string, command string, ...) error
• func UpTo(ctx Ctx, goose *goosepkg.Instance, dir string, version int64, ...) (*schemaver.SchemaVer, error)
• type Ctx

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 Run

func Run(ctx Ctx, goose *goosepkg.Instance, dir string, command string, cfg *mysql.Config) error

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

func UpTo

func UpTo(ctx Ctx, goose *goosepkg.Instance, dir string, version int64, cfg *mysql.Config) (*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 Ctx

type Ctx = context.Context

Ctx is a synonym for convenience.