migrations

Aug 18, 2026

Changes in this version

+ func IsolationLockName(connection string) string

+ type IsolationLock interface

+ Get func(ctx context.Context, fn func(context.Context) error) (bool, error)

type Migrator

+ func (m *Migrator) IsolateWith(issue func(name string) IsolationLock) *Migrator

+ func (m *Migrator) RunIsolated(ctx context.Context, paths []string, options Options) (applied []string, ran bool, err error)

Aug 18, 2026

Changes in this version

+ func DownStatements(ctx context.Context, migration Migration) ([]string, error)

+ func UpStatements(ctx context.Context, migration Migration) ([]string, error)

Aug 14, 2026

Changes in this version

+ const DefaultPath

+ const DefaultTable

+ func Register(migration Migration, path ...string)

+ func RegisteredPaths() []string

+ func ResolveConnectionsUsing(callback func(resolver Resolver, name string) (Connection, error))

+ func WithoutMigrations(names []string)

+ type BaseMigration struct

+ Connection string

+ OutsideTransaction bool

+ func (m BaseMigration) GetConnection() string

+ func (m BaseMigration) ShouldRun() bool

+ func (m BaseMigration) WithinTransaction() bool

+ type Connection interface

+ GetName func() string

+ Select func(ctx context.Context, query string, bindings []any) ([]map[string]any, error)

+ Statement func(ctx context.Context, query string, bindings []any) (bool, error)

+ type DatabaseMigrationRepository struct

+ func NewDatabaseMigrationRepository(resolver Resolver, table string) *DatabaseMigrationRepository

+ func (r *DatabaseMigrationRepository) CreateRepository(ctx context.Context) error

+ func (r *DatabaseMigrationRepository) Delete(ctx context.Context, migration MigrationRecord) error

+ func (r *DatabaseMigrationRepository) DeleteRepository(ctx context.Context) error

+ func (r *DatabaseMigrationRepository) GetConnection() (Connection, error)

+ func (r *DatabaseMigrationRepository) GetConnectionResolver() Resolver

+ func (r *DatabaseMigrationRepository) GetLast(ctx context.Context) ([]MigrationRecord, error)

+ func (r *DatabaseMigrationRepository) GetLastBatchNumber(ctx context.Context) (int, error)

+ func (r *DatabaseMigrationRepository) GetMigrationBatches(ctx context.Context) (map[string]int, error)

+ func (r *DatabaseMigrationRepository) GetMigrations(ctx context.Context, steps int) ([]MigrationRecord, error)

+ func (r *DatabaseMigrationRepository) GetMigrationsByBatch(ctx context.Context, batch int) ([]MigrationRecord, error)

+ func (r *DatabaseMigrationRepository) GetNextBatchNumber(ctx context.Context) (int, error)

+ func (r *DatabaseMigrationRepository) GetRan(ctx context.Context) ([]string, error)

+ func (r *DatabaseMigrationRepository) GetTable() string

+ func (r *DatabaseMigrationRepository) Log(ctx context.Context, file string, batch int) error

+ func (r *DatabaseMigrationRepository) RepositoryExists(ctx context.Context) bool

+ func (r *DatabaseMigrationRepository) SetSource(name string)

+ type Dispatcher interface

+ Dispatch func(event any)

+ type Migration interface

+ GetConnection func() string

+ GetName func() string

+ ShouldRun func() bool

+ Up func(ctx context.Context, conn Connection) error

+ WithinTransaction func() bool

+ func Registered(paths ...string) []Migration

+ type MigrationCreator struct

+ func NewMigrationCreator(customStubPath string) *MigrationCreator

+ func (c *MigrationCreator) AfterCreate(callback func(table, path string))

+ func (c *MigrationCreator) Create(name, path, table string, create bool) (string, error)

+ func (c *MigrationCreator) GetClassName(name string) string

+ func (c *MigrationCreator) GetDatePrefix() string

+ func (c *MigrationCreator) GetPath(name, path string) string

+ func (c *MigrationCreator) StubPath() string

+ type MigrationRecord struct

+ Batch int

+ ID int

+ Migration string

+ type MigrationRepositoryInterface interface

+ CreateRepository func(ctx context.Context) error

+ Delete func(ctx context.Context, migration MigrationRecord) error

+ DeleteRepository func(ctx context.Context) error

+ GetLast func(ctx context.Context) ([]MigrationRecord, error)

+ GetMigrationBatches func(ctx context.Context) (map[string]int, error)

+ GetMigrations func(ctx context.Context, steps int) ([]MigrationRecord, error)

+ GetMigrationsByBatch func(ctx context.Context, batch int) ([]MigrationRecord, error)

+ GetNextBatchNumber func(ctx context.Context) (int, error)

+ GetRan func(ctx context.Context) ([]string, error)

+ Log func(ctx context.Context, file string, batch int) error

+ RepositoryExists func(ctx context.Context) bool

+ SetSource func(name string)

+ type MigrationResult int

+ const Failure

+ const Skipped

+ const Success

+ func (r MigrationResult) String() string

+ type Migrator struct

+ func NewMigrator(repository MigrationRepositoryInterface, resolver Resolver, ...) *Migrator

+ func (m *Migrator) DeleteRepository(ctx context.Context) error

+ func (m *Migrator) FireMigrationEvent(event any)

+ func (m *Migrator) GetConnection() string

+ func (m *Migrator) GetMigrationFiles(paths []string) map[string]Migration

+ func (m *Migrator) GetMigrationName(path string) string

+ func (m *Migrator) GetRepository() MigrationRepositoryInterface

+ func (m *Migrator) HasRunAnyMigrations(ctx context.Context) bool

+ func (m *Migrator) Path(path string)

+ func (m *Migrator) Paths() []string

+ func (m *Migrator) RepositoryExists(ctx context.Context) bool

+ func (m *Migrator) Reset(ctx context.Context, paths []string, pretend bool) ([]string, error)

+ func (m *Migrator) Resolve(name string) (Migration, error)

+ func (m *Migrator) ResolveConnection(connection string) (Connection, error)

+ func (m *Migrator) Rollback(ctx context.Context, paths []string, options Options) ([]string, error)

+ func (m *Migrator) Run(ctx context.Context, paths []string, options Options) ([]string, error)

+ func (m *Migrator) RunPending(ctx context.Context, migrations []Migration, options Options) error

+ func (m *Migrator) SetConnection(name string)

+ func (m *Migrator) SetOutput(output io.Writer) *Migrator

+ func (m *Migrator) UsingConnection(name string, callback func() error) error

+ type Options struct

+ Batch int

+ Pretend bool

+ Step bool

+ Steps int

+ type PretendingConnection interface

+ Pretend func(ctx context.Context, callback func() error) ([]string, error)

+ type Resolver interface

+ Connection func(name string) (Connection, error)

+ GetDefaultConnection func() string

+ SetDefaultConnection func(name string)

+ type ReversibleMigration interface

+ Down func(ctx context.Context, conn Connection) error

+ type TransactionalConnection interface

+ SupportsSchemaTransactions func() bool

+ Transaction func(ctx context.Context, callback func() error) error