migrate

package

v1.0.0 Latest Latest Go to latest Published: May 13, 2026 License: MIT Imports: 4 Imported by: 0

Details

Package migrate provides database migration helpers for containerized databases.

This section is empty.

This section is empty.

func CreateMigration(dir, name string) (string, error)

CreateMigration creates a new migration file pair (up and down).

func ForceVersion(ctx context.Context, db *sql.DB, version string, opts ...migrate.Option) error

ForceVersion sets the schema version without running migrations.

func ListMigrations(dir string) ([]migrate.Migration, error)

ListMigrations returns all available migrations.

type Option func(*Runner)

Option configures the Runner.

func WithDir(dir string) Option

WithDir sets the migrations directory.

func WithTableName(name string) Option

WithTableName sets the migration tracking table name.

func WithTimeout(d time.Duration) Option

WithTimeout sets the timeout for each migration step.

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

Runner handles database migrations for containerized databases.

func NewRunner(db *sql.DB, opts ...Option) *Runner

NewRunner creates a new migration runner.

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

Down rolls back the last N migrations. If steps <= 0, rolls back all.

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

Status returns the status of all migrations.

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

Up runs all pending up migrations.