libschema

Mar 9, 2026

Changes in this version

type MigrationBase

+ func (m *MigrationBase) PreserveComments() bool

type MigrationOption

+ func PreserveComments() MigrationOption

Feb 10, 2026

Changes in this version

type MigrationBase

+ func (m *MigrationBase) RepeatUntilNoOp() bool

Feb 2, 2026

Changes in this version

type MigrationBase

+ func (m *MigrationBase) Notes() map[string]any

+ func (m *MigrationBase) SetNote(key string, value any)

Oct 24, 2025

Changes in this version

+ const ErrDataAndDDL

+ const ErrNonIdempotentDDL

+ const ErrNonIdempotentNonTx

+ const ErrNonTxMultipleStatements

type MigrationBase

+ func (m *MigrationBase) ApplyForceOverride()

+ func (m *MigrationBase) ForcedNonTransactional() bool

+ func (m *MigrationBase) ForcedTransactional() bool

+ func (m *MigrationBase) NonTransactional() bool

+ func (m *MigrationBase) SetNonTransactional(v bool)

type MigrationOption

+ func ForceNonTransactional() MigrationOption

+ func ForceTransactional() MigrationOption

Dec 24, 2022

Changes in this version

type Database

+ DBName string

Apr 29, 2022

Changes in this version

+ func LogFromLog(logger interface{ ... }) *internal.Log

+ func LogFromLogur(logur Logur) *internal.Log

+ func LogFromPrintln(printer interface{ ... }) *internal.Log

type Database

+ Name string

+ type Logur interface

+ Debug func(msg string, fields ...map[string]interface{})

+ Error func(msg string, fields ...map[string]interface{})

+ Info func(msg string, fields ...map[string]interface{})

+ Trace func(msg string, fields ...map[string]interface{})

+ Warn func(msg string, fields ...map[string]interface{})

type MigrationOption

+ func Asynchronous() MigrationOption

+ func RepeatUntilNoOp() MigrationOption

type Options

+ Overrides *OverrideOptions

+ type OverrideOptions struct

+ ErrorIfMigrateNeeded bool

+ EverythingSynchronous bool

+ MigrateDSN string

+ MigrateDatabase string

+ MigrateOnly bool

+ NoMigrate bool

+ var DefaultOverrides OverrideOptions

Mar 30, 2022

Changes in this version

+ const DefaultTrackingTable

+ var EverythingSynchronous = flag.Bool("migrate-all-synchronously", false, "Run async migrations synchronously")

+ var ExitIfMigrateNeeded = flag.Bool("exit-if-migrate-needed", false, "Return error if migrations are not current")

+ var MigrateDSN = flag.String("migrate-dsn", "", "Override *sql.DB")

+ var MigrateDatabase = flag.String("migrate-database", "", "Migrate only the database named by NewDatabase")

+ var MigrateOnly = flag.Bool("migrate-only", false, "Call os.Exit() after completing migrations")

+ var NoMigrate = flag.Bool("no-migrate", false, "Skip all migrations (except async)")

+ func OpenAnyDB(dsn string) (*sql.DB, error)

+ type Database struct

+ Context context.Context

+ Options Options

+ func (d *Database) DB() *sql.DB

+ func (d *Database) Lookup(name MigrationName) (Migration, bool)

+ func (d *Database) Migrations(libraryName string, migrations ...Migration)

+ type Driver interface

+ CreateSchemaTableIfNotExists func(context.Context, MyLogger, *Database) error

+ DoOneMigration func(context.Context, MyLogger, *Database, Migration) error

+ IsMigrationSupported func(*Database, MyLogger, Migration) error

+ LoadStatus func(context.Context, MyLogger, *Database) ([]MigrationName, error)

+ LockMigrationsTable func(context.Context, MyLogger, *Database) error

+ UnlockMigrationsTable func(MyLogger) error

+ type Migration interface

+ Base func() *MigrationBase

+ Copy func() Migration

+ type MigrationBase struct

+ Name MigrationName

+ func (m *MigrationBase) HasSkipIf() bool

+ func (m *MigrationBase) SetStatus(status MigrationStatus)

+ func (m *MigrationBase) Status() MigrationStatus

+ func (m MigrationBase) Copy() MigrationBase

+ type MigrationName struct

+ Library string

+ Name string

+ func (n MigrationName) String() string

+ type MigrationOption func(Migration)

+ func After(lib, migration string) MigrationOption

+ func Asyncrhronous() MigrationOption

+ func SkipIf(pred func() (bool, error)) MigrationOption

+ func SkipRemainingIf(pred func() (bool, error)) MigrationOption

+ type MigrationStatus struct

+ Done bool

+ Error string

+ type MyLogger interface

+ Debug func(msg string, fields ...map[string]interface{})

+ Error func(msg string, fields ...map[string]interface{})

+ Info func(msg string, fields ...map[string]interface{})

+ Trace func(msg string, fields ...map[string]interface{})

+ Warn func(msg string, fields ...map[string]interface{})

+ type Options struct

+ DebugLogging bool

+ ErrorOnUnknownMigrations bool

+ MigrationTxOptions *sql.TxOptions

+ OnMigrationFailure func(n MigrationName, err error)

+ OnMigrationsComplete func(error)

+ OnMigrationsStarted func()

+ SchemaOverride string

+ TrackingTable string

+ type Schema struct

+ func New(ctx context.Context, options Options) *Schema

+ func (s *Schema) Migrate(ctx context.Context) (err error)

+ func (s *Schema) NewDatabase(log MyLogger, name string, db *sql.DB, driver Driver) (*Database, error)