migrator

Documentation

Index

• type Migration
• type Options
• type Runner
  • func New(db *sql.DB, opts Options) *Runner
  • func (r *Runner) Down(ctx context.Context) error
  • func (r *Runner) Status(ctx context.Context) (string, error)
  • func (r *Runner) Up(ctx context.Context) error

Types

type Migration

type Migration struct {
	Version  int64
	Name     string
	Dir      string // "up" or "down"
	File     string
	SQL      string
	Checksum string
}

Migration is a versioned SQL change.

type Options

type Options struct {
	// MigrationsDir is kept for backward compatibility. If non-empty,
	// it will be appended to MigrationsDirs.
	MigrationsDir string
	// MigrationsDirs allows loading migrations from multiple directories.
	// Directories are processed in order; later files with the same name
	// override earlier ones before parsing.
	MigrationsDirs []string
	// EmbeddedFSs allows loading migrations from multiple embedded
	// filesystems. Each is expected to contain a "migrations" directory.
	// Embedded filesystems are appended after explicit directories.
	EmbeddedFSs []fs.FS
	TableName   string
	LockKey     int64
	// AllowDangerousDown enables Down(); keep disabled in API binaries.
	AllowDangerousDown bool
	// Logger outputs formatted status messages.
	Logger func(format string, args ...any)
}

Options configures the runner.

type Runner

type Runner struct {
	DB   *sql.DB
	Opts Options
	// contains filtered or unexported fields
}

Runner executes SQL migrations transactionally and records state.

func New

func New(db *sql.DB, opts Options) *Runner

func (*Runner) Down

func (r *Runner) Down(ctx context.Context) error

Down reverts the latest successfully applied version by 1 step.

func (*Runner) Status

func (r *Runner) Status(ctx context.Context) (string, error)

Status reports current and pending state.

func (*Runner) Up

func (r *Runner) Up(ctx context.Context) error

Up applies all pending "up" migrations.