const (
Pending = "Pending"
Applied = "Applied"
)
const (
MigrationStatusOpName = "migration-status"
MigrationInitOpName = "migration-init"
MigrationUpOpName = "migration-up"
MigrationRunTransactionOpName = "migration-run-transaction"
MigrationDownOpName = "migration-down"
)
func ParameterizedMigrationContent(params map[string]interface{}) func(mf Migration, c *pop.Connection, r []byte, usingTemplate bool) (string, error)
func WithMigrationContentMiddleware(middleware func(content string, err error) (string, error)) func(*MigrationBox) *MigrationBox
func WithTemplateValues(v map[string]interface{}) func(*MigrationBox) *MigrationBox
Migration handles the data for a given database migration
type Migration struct {
// Path to the migration (./migrations/123_create_widgets.up.sql)
Path string
// Version of the migration (123)
Version string
// Name of the migration (create_widgets)
Name string
// Direction of the migration (up)
Direction string
// Type of migration (sql)
Type string
// DB type (all|postgres|mysql...)
DBType string
// Runner function to run/execute the migration
Runner func(Migration, *pop.Connection, *pop.Tx) error
}
func (mf Migration) Run(c *pop.Connection, tx *pop.Tx) error
Run the migration. Returns an error if there is no mf.Runner defined.
MigrationBox is a embed migration box.
type MigrationBox struct {
*Migrator
Dir embed.FS
// contains filtered or unexported fields
}
func NewMigrationBox(dir embed.FS, m *Migrator, opts ...func(*MigrationBox) *MigrationBox) (*MigrationBox, error)
NewMigrationBox from a packr.Dir and a Connection.
migrations, err := NewMigrationBox(pkger.Dir("/migrations"))
type MigrationContent func(mf Migration, c *pop.Connection, r []byte, usingTemplate bool) (string, error)
type MigrationStatus struct {
State string `json:"state"`
Version string `json:"version"`
Name string `json:"name"`
}
type MigrationStatuses []MigrationStatus
func (m MigrationStatuses) HasPending() bool
func (m MigrationStatuses) Header() []string
func (m MigrationStatuses) IDs() []string
func (m MigrationStatuses) Interface() interface{}
func (m MigrationStatuses) Len() int
func (m MigrationStatuses) Table() [][]string
func (m MigrationStatuses) Write(out io.Writer) error
In the context of a cobra.Command, use cmdx.PrintTable instead.
Migrations is a collection of Migration
type Migrations []Migration
func (mfs Migrations) Len() int
func (mfs Migrations) Less(i, j int) bool
func (mfs Migrations) SortAndFilter(dialect string, modifiers ...func(sort.Interface) sort.Interface) Migrations
func (mfs Migrations) Swap(i, j int)
Migrator forms the basis of all migrations systems. It does the actual heavy lifting of running migrations. When building a new migration system, you should embed this type into your migrator.
type Migrator struct {
Connection *pop.Connection
SchemaPath string
Migrations map[string]Migrations
PerMigrationTimeout time.Duration
// contains filtered or unexported fields
}
func NewMigrator(c *pop.Connection, l *logrusx.Logger, tracer *tracing.Tracer, perMigrationTimeout time.Duration) *Migrator
NewMigrator returns a new "blank" migrator. It is recommended to use something like MigrationBox or FileMigrator. A "blank" Migrator should only be used as the basis for a new type of migration system.
func (m *Migrator) CreateSchemaMigrations(ctx context.Context) error
CreateSchemaMigrations sets up a table to track migrations. This is an idempotent operation.
func (m *Migrator) Down(ctx context.Context, step int) error
Down runs pending "down" migrations and rolls back the database by the specified number of steps.
func (m *Migrator) DumpMigrationSchema(ctx context.Context) error
DumpMigrationSchema will generate a file of the current database schema based on the value of Migrator.SchemaPath
func (m *Migrator) MigrationIsCompatible(dialect string, mi Migration) bool
func (m *Migrator) Reset(ctx context.Context) error
Reset the database by running the down migrations followed by the up migrations.
func (m *Migrator) Status(ctx context.Context) (MigrationStatuses, error)
Status prints out the status of applied/pending migrations.
func (m *Migrator) Up(ctx context.Context) error
Up runs pending "up" migrations and applies them to the database.
func (m *Migrator) UpTo(ctx context.Context, step int) (applied int, err error)
UpTo runs up to step "up" migrations and applies them to the database. If step <= 0 all pending migrations are run.
TestMigrator is a modified pop.FileMigrator
type TestMigrator struct {
*Migrator
}
func NewTestMigrator(t *testing.T, c *pop.Connection, migrationPath, testDataPath string, l *logrusx.Logger) *TestMigrator
Returns a new TestMigrator After running each migration it applies it's corresponding testData sql files. They are identified by having the same version (= number in the front of the filename). The filenames are expected to be of the format ([0-9]+).*(_testdata(\.[dbtype])?.sql