Documentation
¶
Overview ¶
Package migrator is a public pzero runtime API for PostgreSQL schema migration execution and service commands backed by pgx.
Index ¶
- Constants
- Variables
- func NewCommand(loadSQLConf SQLConfigLoader) *cobra.Command
- func WithSource(source string) opts.Opt[Options]
- func WithSourceAppendDriver(sourceAppendDriver bool) opts.Opt[Options]
- func WithXMigrationsTable(xMigrationsTable string) opts.Opt[Options]
- type Migrator
- type Options
- type SQLConfigLoader
Constants ¶
View Source
const MigrationDir = "desc/sql_migration"
Variables ¶
View Source
var ( DefaultXMigrationsTable = "schema_migrations" DefaultSource = "file://desc/sql_migration" )
Functions ¶
func NewCommand ¶
func NewCommand(loadSQLConf SQLConfigLoader) *cobra.Command
NewCommand builds a migrate command for a service root command. The service root must expose an inherited string flag named "config".
func WithSourceAppendDriver ¶
Types ¶
type Migrator ¶
type Migrator 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
// Force sets a migration version and clears the dirty state without
// running migrations.
Force(version int) 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)
}
type Options ¶
func (Options) DefaultOptions ¶
Click to show internal directories.
Click to hide internal directories.