migrate

Documentation

Overview

Package migrate supports a dbmate-compatible superset of migration files.

The superset is that in addition to a migration being a .sql file, it can also be a Go function which is called to execute the migration.

Index

• func Migrate(ctx context.Context, db *sql.DB, migrationFiles fs.FS, options ...Option) error
• type MigrationFunc
• type Option
  • func LogLevel(level log.Level) Option
  • func Migration(version, name string, migration MigrationFunc) Option

Functions

func Migrate

func Migrate(ctx context.Context, db *sql.DB, migrationFiles fs.FS, options ...Option) error

Migrate applies all migrations in the provided fs.FS and migration functions to the provided database.

Types

type MigrationFunc

type MigrationFunc func(ctx context.Context, db *sql.Tx) error

type Option

type Option func(*migrateOptions)

Option is a configuration option for Migrate.

func LogLevel

func LogLevel(level log.Level) Option

LogLevel sets the logging level of the migrator.

func Migration

func Migration(version, name string, migration MigrationFunc) Option

Migration adds a named migration function to the migration set.

"version" must be in the form "<YYYY><MM><DD><hh><mm><ss>".