migrate

package

v0.1.0 Latest Latest Go to latest Published: Jan 17, 2026 License: MIT Imports: 10 Imported by: 0

Details

This section is empty.

View Source

var ErrLockTimeout = errors.New("migration lock timeout")

ErrLockTimeout indicates a lock timeout.

This section is empty.

type AdvisoryLocker struct {
	ID           int64
	Timeout      time.Duration
	PollInterval time.Duration
}

AdvisoryLocker uses PostgreSQL advisory locks.

func (a AdvisoryLocker) Lock(ctx context.Context, db *sql.DB) error

Lock acquires a PostgreSQL advisory lock.

func (a AdvisoryLocker) Unlock(ctx context.Context, db *sql.DB) error

Unlock releases a PostgreSQL advisory lock.

type Locker interface {
	Lock(context.Context, *sql.DB) error
	Unlock(context.Context, *sql.DB) error
}

Locker handles migration locking.

type Migration struct {
	Version  int
	Name     string
	UpPath   string
	DownPath string
}

Migration describes a migration pair.

func List(dir string) ([]Migration, error)

List returns migrations found in a directory.

type PlanEntry struct {
	Migration
	Applied bool
}

PlanEntry describes a migration and whether it has been applied.

type Runner struct {
	DB     *sql.DB
	Dir    string
	Table  string
	Locker Locker
}

Runner executes migrations from a directory.

func New(db *sql.DB, dir string) *Runner

New creates a new Runner.

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

Down rolls back the latest migrations.

func (r *Runner) Plan(ctx context.Context) ([]PlanEntry, error)

Plan returns a migration plan, optionally marking applied migrations.

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

Up applies all pending migrations.