migrate

Documentation

Overview

Package migrate provides database migration runners and CLI commands.

Index

• Variables
• func Command(runner Runner) cli.Command
• type Dialect
• type GooseRunner
  • func New(db *sql.DB, dialect Dialect, migrations fs.FS, opts ...Option) (*GooseRunner, error)
  • func NewFromDir(db *sql.DB, dialect Dialect, dir string, opts ...Option) (*GooseRunner, error)
  • func (r *GooseRunner) Down(ctx context.Context) (Result, error)
  • func (r *GooseRunner) Reset(ctx context.Context) ([]Result, error)
  • func (r *GooseRunner) Status(ctx context.Context) ([]Status, error)
  • func (r *GooseRunner) Up(ctx context.Context) ([]Result, error)
• type Option
  • func WithTableName(tableName string) Option
• type Result
• type Runner
• type Status

Variables

var ErrUnsupportedDialect = errors.New("unsupported migration dialect")

ErrUnsupportedDialect reports that a migration dialect is not supported.

Functions

func Command

func Command(runner Runner) cli.Command

Command returns a migrate command with up, down, reset, and status subcommands.

Types

type Dialect

type Dialect string

Dialect identifies a database migration dialect.

const (
	// DialectPostgres runs migrations against Postgres.
	DialectPostgres Dialect = "postgres"
	// DialectSQLite runs migrations against SQLite.
	DialectSQLite Dialect = "sqlite"
)

type GooseRunner

type GooseRunner struct {
	// contains filtered or unexported fields
}

GooseRunner applies migrations with goose.

func New

func New(db *sql.DB, dialect Dialect, migrations fs.FS, opts ...Option) (*GooseRunner, error)

New creates a goose-backed migration runner. The caller owns db and remains responsible for closing it.

func NewFromDir

func NewFromDir(db *sql.DB, dialect Dialect, dir string, opts ...Option) (*GooseRunner, error)

NewFromDir creates a goose-backed migration runner from a local directory.

func (*GooseRunner) Down

func (r *GooseRunner) Down(ctx context.Context) (Result, error)

Down rolls back one migration.

func (*GooseRunner) Reset

func (r *GooseRunner) Reset(ctx context.Context) ([]Result, error)

Reset rolls back all applied migrations.

func (*GooseRunner) Status

func (r *GooseRunner) Status(ctx context.Context) ([]Status, error)

Status returns migration state.

func (*GooseRunner) Up

func (r *GooseRunner) Up(ctx context.Context) ([]Result, error)

Up applies all pending migrations.

type Option

type Option func(*gooseOptions)

Option configures a GooseRunner.

func WithTableName

func WithTableName(tableName string) Option

WithTableName configures the migration version table name.

type Result

type Result struct {
	Version   int64
	Source    string
	Direction string
	Duration  time.Duration
	Empty     bool
	Skipped   bool
}

Result describes one applied migration.

type Runner

type Runner interface {
	Up(context.Context) ([]Result, error)
	Down(context.Context) (Result, error)
	Reset(context.Context) ([]Result, error)
	Status(context.Context) ([]Status, error)
}

Runner applies and inspects database migrations.

type Status

type Status struct {
	Version   int64
	Source    string
	State     string
	AppliedAt time.Time
}

Status describes one migration status row.