migrate

package

v0.3.2 Latest Latest Go to latest Published: Nov 3, 2026 License: MIT Imports: 10 Imported by: 0

Details

Package migrate provides lightweight database migration helpers based on pressly/goose/v3.

This section is empty.

This section is empty.

func GetDBVersion(ctx context.Context, db *sql.DB, driver string, opts ...Option) (int64, error)

GetDBVersion returns the current database version.

func GetStatus(ctx context.Context, db *sql.DB, driver string, fsys fs.FS, dir string, opts ...Option) ([]*goose.MigrationStatus, error)

GetStatus returns the current migration status list.

func NewProvider(db *sql.DB, driver string, fsys fs.FS, dir string, opts ...Option) (*goose.Provider, error)

NewProvider creates a new goose.Provider instance with isolated state.

func RunDown(ctx context.Context, db *sql.DB, driver string, dir string, opts ...Option) error

RunDown rolls back the most recently applied migration from a local filesystem directory.

func RunDownFS(ctx context.Context, db *sql.DB, driver string, fsys fs.FS, dir string, opts ...Option) error

RunDown rolls back the most recently applied migration from a given fs.FS.

func RunUp(ctx context.Context, db *sql.DB, driver string, dir string, opts ...Option) error

RunUp executes all pending migrations from a local filesystem directory.

func RunUpFS(ctx context.Context, db *sql.DB, driver string, fsys fs.FS, dir string, opts ...Option) error

RunUpFS executes all pending migrations from a given fs.FS (e.g. embed.FS or os.DirFS).

func ToGooseDialect(driver string) (goose.Dialect, error)

ToGooseDialect maps framework database driver names (mysql, postgres, sqlite) to standard goose.Dialect.

type Option func(*options)

Option defines a functional option for configuring migration executions.

func WithTableName(table string) Option

WithTableName configures a custom table name for tracking migration versions (default: "goose_db_version").