Documentation
¶
Index ¶
- Constants
- type Audited
- type AuditedMigration
- type AuditedMigrationSet
- type Builder
- type Clock
- type Command
- type CommandAudit
- type CommandMigrateDown
- type CommandMigrateFixDown
- type CommandMigrateFixUp
- type CommandMigrateStatus
- type CommandMigrateUp
- type CurrentTime
- type GenerateInitOptions
- type GenerateMigrationOptions
- type Generator
- type MigrateAuditOptions
- type MigrateAuditResult
- type MigrateDownOptions
- type MigrateDownResult
- type MigrateFixDownOptions
- type MigrateFixDownResult
- type MigrateFixUpOptions
- type MigrateFixUpResult
- type MigrateStatusOptions
- type MigrateStatusResult
- type MigrateUpOptions
- type MigrateUpResult
- type MigrationStatusResultSingle
- type MigrationVersion
- type Migrator
- func (m *Migrator) MigrateAudit(ctx context.Context, cfg *config.Config, opts MigrateAuditOptions) (*MigrateAuditResult, error)
- func (m *Migrator) MigrateDown(ctx context.Context, cfg *config.Config, opts MigrateDownOptions) (*MigrateDownResult, error)
- func (m *Migrator) MigrateFixDown(ctx context.Context, cfg *config.Config, opts MigrateFixDownOptions) (*MigrateFixDownResult, error)
- func (m *Migrator) MigrateFixUp(ctx context.Context, cfg *config.Config, opts MigrateFixUpOptions) (*MigrateFixUpResult, error)
- func (m *Migrator) MigrateStatus(ctx context.Context, cfg *config.Config, opts MigrateStatusOptions) (*MigrateStatusResult, error)
- func (m *Migrator) MigrateUp(ctx context.Context, cfg *config.Config, opts MigrateUpOptions) (*MigrateUpResult, error)
- type Navigator
- func (n *Navigator) ComputeState(ctx context.Context, conn plugin.DriverConnection) (*Audited, error)
- func (n *Navigator) Drive(ctx context.Context, conn plugin.DriverConnection, run func() error) error
- func (n *Navigator) Mark(ctx context.Context, conn plugin.DriverConnection, log plugin.DriverAuditLog) error
- func (n *Navigator) Open(ctx context.Context) (plugin.DriverConnection, func(), error)
- func (n *Navigator) Ready(ctx context.Context, conn plugin.DriverConnection) error
- func (n *Navigator) WithTx(ctx context.Context, conn plugin.DriverConnection, withTx bool, ...) error
- type Runner
- func (r *Runner) ExecuteMigrateAudit(ctx context.Context, cmd *CommandAudit) (*MigrateAuditResult, error)
- func (r *Runner) ExecuteMigrateDown(ctx context.Context, cmd *CommandMigrateDown) (*MigrateDownResult, error)
- func (r *Runner) ExecuteMigrateFixDown(ctx context.Context, cmd *CommandMigrateFixDown) (*MigrateFixDownResult, error)
- func (r *Runner) ExecuteMigrateFixUp(ctx context.Context, cmd *CommandMigrateFixUp) (*MigrateFixUpResult, error)
- func (r *Runner) ExecuteMigrateStatus(ctx context.Context, cmd *CommandMigrateStatus) (*MigrateStatusResult, error)
- func (r *Runner) ExecuteMigrateUp(ctx context.Context, cmd *CommandMigrateUp) (*MigrateUpResult, error)
- func (r *Runner) UseConfig() (*config.Config, error)
- func (r *Runner) UseDriver(cfg *config.Config, name string) (*plugin.DriverInstance, error)
- func (r *Runner) UseMigrationSet(cfg *config.Config, name string) (*config.MigrationSet, error)
Constants ¶
View Source
const ( AuditStatusStarted = "started" AuditStatusCompleted = "completed" AuditStatusFailed = "failed" MigrationUpStartedEvent = "migration.up.started" MigrationUpCompletedEvent = "migration.up.completed" MigrationUpFailedEvent = "migration.up.failed" MigrationFixUpEvent = "migration.up.fixed" MigrationDownStartedEvent = "migration.down.started" MigrationDownCompletedEvent = "migration.down.completed" MigrationDownFailedEvent = "migration.down.failed" MigrationFixDownEvent = "migration.down.fixed" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Audited ¶
type Audited struct {
Raw []plugin.DriverAuditLog
Sets map[string]*AuditedMigrationSet
LastID int64
}
func (*Audited) EnsureMigrationSet ¶
func (a *Audited) EnsureMigrationSet(name string) *AuditedMigrationSet
type AuditedMigration ¶
type AuditedMigration struct {
Name string
Version MigrationVersion
Status string
WasDuringRollback bool
}
type AuditedMigrationSet ¶
type AuditedMigrationSet struct {
Migrations map[MigrationVersion]*AuditedMigration
}
func (*AuditedMigrationSet) DeleteMigration ¶
func (a *AuditedMigrationSet) DeleteMigration(version MigrationVersion)
func (*AuditedMigrationSet) EnsureMigration ¶
func (a *AuditedMigrationSet) EnsureMigration(version MigrationVersion, name string) *AuditedMigration
type Builder ¶
type Builder struct {
// contains filtered or unexported fields
}
func NewBuilder ¶
func NewBuilder( fs *config.Filesystem, parsed *config.ParsedConfig, registry *plugins.Registry, ) *Builder
type CommandAudit ¶
type CommandMigrateDown ¶
type CommandMigrateFixDown ¶
type CommandMigrateFixUp ¶
type CommandMigrateStatus ¶
type CommandMigrateUp ¶
type CurrentTime ¶
type CurrentTime struct{}
func (*CurrentTime) Now ¶
func (t *CurrentTime) Now() time.Time
type GenerateInitOptions ¶
type GenerateInitOptions struct {
}
type GenerateMigrationOptions ¶
type GenerateMigrationOptions struct {
}
type Generator ¶
type Generator struct {
// contains filtered or unexported fields
}
func NewGenerator ¶
func NewGenerator(fs *config.Filesystem, tpls *tpls.Templates, timestampGenerator generators.TimestampGenerator) *Generator
func (*Generator) GenInit ¶
func (g *Generator) GenInit(ctx context.Context, opts GenerateInitOptions) error
func (*Generator) GenMigration ¶
func (g *Generator) GenMigration(ctx context.Context, opts GenerateMigrationOptions) error
type MigrateAuditOptions ¶
type MigrateAuditOptions struct {
Driver *plugin.DriverInstance
Set *config.MigrationSet
FilterLastN uint
}
type MigrateAuditResult ¶
type MigrateAuditResult struct {
Logs []plugin.DriverAuditLog
}
type MigrateDownOptions ¶
type MigrateDownOptions struct {
Driver *plugin.DriverInstance
Set *config.MigrationSet
Version string
}
type MigrateDownResult ¶
type MigrateDownResult struct {
}
type MigrateFixDownOptions ¶
type MigrateFixDownOptions struct {
Driver *plugin.DriverInstance
Set *config.MigrationSet
Version string
Comment string
}
type MigrateFixDownResult ¶
type MigrateFixDownResult struct{}
type MigrateFixUpOptions ¶
type MigrateFixUpOptions struct {
Driver *plugin.DriverInstance
Set *config.MigrationSet
Version string
Comment string
}
type MigrateFixUpResult ¶
type MigrateFixUpResult struct {
}
type MigrateStatusOptions ¶
type MigrateStatusOptions struct {
Driver *plugin.DriverInstance
Set *config.MigrationSet
}
type MigrateStatusResult ¶
type MigrateStatusResult struct {
Rows []MigrationStatusResultSingle
}
type MigrateUpOptions ¶
type MigrateUpOptions struct {
Driver *plugin.DriverInstance
Set *config.MigrationSet
}
type MigrateUpResult ¶
type MigrateUpResult struct {
WasPending int
}
type MigrationVersion ¶
type MigrationVersion string
type Migrator ¶
type Migrator struct {
// contains filtered or unexported fields
}
func NewMigrator ¶
func (*Migrator) MigrateAudit ¶
func (m *Migrator) MigrateAudit(ctx context.Context, cfg *config.Config, opts MigrateAuditOptions) (*MigrateAuditResult, error)
func (*Migrator) MigrateDown ¶
func (m *Migrator) MigrateDown(ctx context.Context, cfg *config.Config, opts MigrateDownOptions) (*MigrateDownResult, error)
func (*Migrator) MigrateFixDown ¶
func (m *Migrator) MigrateFixDown(ctx context.Context, cfg *config.Config, opts MigrateFixDownOptions) (*MigrateFixDownResult, error)
func (*Migrator) MigrateFixUp ¶
func (m *Migrator) MigrateFixUp(ctx context.Context, cfg *config.Config, opts MigrateFixUpOptions) (*MigrateFixUpResult, error)
func (*Migrator) MigrateStatus ¶
func (m *Migrator) MigrateStatus(ctx context.Context, cfg *config.Config, opts MigrateStatusOptions) (*MigrateStatusResult, error)
func (*Migrator) MigrateUp ¶
func (m *Migrator) MigrateUp(ctx context.Context, cfg *config.Config, opts MigrateUpOptions) (*MigrateUpResult, error)
type Navigator ¶
type Navigator struct {
// contains filtered or unexported fields
}
Navigator abstracts the flow of the driver.
func NewNavigator ¶
func NewNavigator(driver *plugin.DriverInstance, config *config.Config, execCtx plugin.DriverExecutionContext, clock Clock) *Navigator
func (*Navigator) ComputeState ¶
func (*Navigator) Mark ¶
func (n *Navigator) Mark(ctx context.Context, conn plugin.DriverConnection, log plugin.DriverAuditLog) error
type Runner ¶
type Runner struct {
// contains filtered or unexported fields
}
func (*Runner) ExecuteMigrateAudit ¶
func (r *Runner) ExecuteMigrateAudit(ctx context.Context, cmd *CommandAudit) (*MigrateAuditResult, error)
func (*Runner) ExecuteMigrateDown ¶
func (r *Runner) ExecuteMigrateDown(ctx context.Context, cmd *CommandMigrateDown) (*MigrateDownResult, error)
func (*Runner) ExecuteMigrateFixDown ¶
func (r *Runner) ExecuteMigrateFixDown(ctx context.Context, cmd *CommandMigrateFixDown) (*MigrateFixDownResult, error)
func (*Runner) ExecuteMigrateFixUp ¶
func (r *Runner) ExecuteMigrateFixUp(ctx context.Context, cmd *CommandMigrateFixUp) (*MigrateFixUpResult, error)
func (*Runner) ExecuteMigrateStatus ¶
func (r *Runner) ExecuteMigrateStatus(ctx context.Context, cmd *CommandMigrateStatus) (*MigrateStatusResult, error)
func (*Runner) ExecuteMigrateUp ¶
func (r *Runner) ExecuteMigrateUp(ctx context.Context, cmd *CommandMigrateUp) (*MigrateUpResult, error)
func (*Runner) UseMigrationSet ¶
Click to show internal directories.
Click to hide internal directories.