migrate

Documentation

Index

• Variables
• func FindMigrations(path string) ([]string, error)
• func FindMigrationsEx(path string, fs MigratorFS) ([]string, error)
• func InstallCodePackage(ctx context.Context, conn Querier, mergeData map[string]interface{}, ...) (err error)
• func LockExecTx(ctx context.Context, conn Querier, sql string) (err error)
• type BadVersionError
  • func (e BadVersionError) Error() string
• type CodePackage
  • func LoadCodePackage(path string) (*CodePackage, error)
  • func LoadCodePackageEx(path string, fs MigratorFS) (*CodePackage, error)
  • func (cp *CodePackage) Eval(data map[string]interface{}) (string, error)
• type IrreversibleMigrationError
  • func (e IrreversibleMigrationError) Error() string
• type Migration
• type MigrationPgError
• type Migrator
  • func NewMigrator(ctx context.Context, conn Querier, versionTable string) (m *Migrator, err error)
  • func NewMigratorEx(ctx context.Context, conn Querier, versionTable string, opts *MigratorOptions) (m *Migrator, err error)
  • func (m *Migrator) AppendMigration(name, upSQL, downSQL string)
  • func (m *Migrator) GetCurrentVersion(ctx context.Context) (v int32, err error)
  • func (m *Migrator) LoadMigrations(path string) error
  • func (m *Migrator) Migrate(ctx context.Context) error
  • func (m *Migrator) MigrateTo(ctx context.Context, targetVersion int32) (err error)
• type MigratorFS
• type MigratorOptions
• type NoMigrationsFoundError
  • func (e NoMigrationsFoundError) Error() string
• type Querier

Variables

var ErrNoFwMigration = errors.New("no sql in forward migration step")

Functions

func FindMigrations

func FindMigrations(path string) ([]string, error)

func FindMigrationsEx

func FindMigrationsEx(path string, fs MigratorFS) ([]string, error)

func InstallCodePackage

func InstallCodePackage(ctx context.Context, conn Querier, mergeData map[string]interface{}, codePackage *CodePackage) (err error)

func LockExecTx

func LockExecTx(ctx context.Context, conn Querier, sql string) (err error)

Types

type BadVersionError

type BadVersionError string

func (BadVersionError) Error

func (e BadVersionError) Error() string

type CodePackage

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

func LoadCodePackage

func LoadCodePackage(path string) (*CodePackage, error)

func LoadCodePackageEx

func LoadCodePackageEx(path string, fs MigratorFS) (*CodePackage, error)

func (*CodePackage) Eval

func (cp *CodePackage) Eval(data map[string]interface{}) (string, error)

type IrreversibleMigrationError

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

func (IrreversibleMigrationError) Error

func (e IrreversibleMigrationError) Error() string

type Migration

type Migration struct {
	Sequence int32
	Name     string
	UpSQL    string
	DownSQL  string
}

type MigrationPgError

type MigrationPgError struct {
	Sql string
	*pgconn.PgError
}

type Migrator

type Migrator struct {
	Migrations []*Migration
	OnStart    func(int32, string, string, string) // OnStart is called when a migration is run with the sequence, name, direction, and SQL
	Data       map[string]interface{}              // Data available to use in migrations
	// contains filtered or unexported fields
}

func NewMigrator

func NewMigrator(ctx context.Context, conn Querier, versionTable string) (m *Migrator, err error)

NewMigrator initializes a new Migrator. It is highly recommended that versionTable be schema qualified.

func NewMigratorEx

func NewMigratorEx(ctx context.Context, conn Querier, versionTable string, opts *MigratorOptions) (m *Migrator, err error)

NewMigratorEx initializes a new Migrator. It is highly recommended that versionTable be schema qualified.

func (*Migrator) AppendMigration

func (m *Migrator) AppendMigration(name, upSQL, downSQL string)

func (*Migrator) GetCurrentVersion

func (m *Migrator) GetCurrentVersion(ctx context.Context) (v int32, err error)

func (*Migrator) LoadMigrations

func (m *Migrator) LoadMigrations(path string) error

func (*Migrator) Migrate

func (m *Migrator) Migrate(ctx context.Context) error

Migrate runs pending migrations It calls m.OnStart when it begins a migration

func (*Migrator) MigrateTo

func (m *Migrator) MigrateTo(ctx context.Context, targetVersion int32) (err error)

MigrateTo migrates to targetVersion

type MigratorFS

type MigratorFS interface {
	ReadDir(dirname string) ([]os.FileInfo, error)
	ReadFile(filename string) ([]byte, error)
	Glob(pattern string) (matches []string, err error)
}

type MigratorOptions

type MigratorOptions struct {
	// DisableTx causes the Migrator not to run migrations in a transaction.
	DisableTx bool
	// MigratorFS is the interface used for collecting the migrations.
	MigratorFS MigratorFS
}

type NoMigrationsFoundError

type NoMigrationsFoundError struct {
	Path string
}

func (NoMigrationsFoundError) Error

func (e NoMigrationsFoundError) Error() string

type Querier

type Querier interface {
	Begin(ctx context.Context) (pgx.Tx, error)
	Exec(ctx context.Context, sql string, arguments ...interface{}) (pgconn.CommandTag, error)
	QueryRow(ctx context.Context, sql string, args ...interface{}) pgx.Row
}