Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var ( DefaultXMigrationsTable = "schema_migrations" DefaultSource = "file://desc/sql_migration" )
Functions ¶
func WithSource ¶
func WithSource(source string) opts.Opt[MigrateOpts]
func WithSourceAppendDriver ¶
func WithSourceAppendDriver(sourceAppendDriver bool) opts.Opt[MigrateOpts]
func WithXMigrationsTable ¶
func WithXMigrationsTable(xMigrationsTable string) opts.Opt[MigrateOpts]
Types ¶
type Migrate ¶
type Migrate interface {
// Up looks at the currently active migration version
// and will migrate all the way up (default applying all up migrations).
Up(steps ...uint) error
// Down looks at the currently active migration version
// and will migrate all the way down (default applying all down migrations).
Down(steps ...uint) error
// Goto looks at the currently active migration version,
// then migrates either up or down to the specified version.
Goto(version uint) error
// Version returns the currently active migration version.
// If no migration has been applied, yet, it will return ErrNilVersion.
Version() (version uint, dirty bool, err error)
// Close source and database, return source error and database error
Close() (error, error)
}
func NewMigrate ¶
type MigrateOpts ¶
func (MigrateOpts) DefaultOptions ¶
func (d MigrateOpts) DefaultOptions() MigrateOpts
Click to show internal directories.
Click to hide internal directories.