Documentation
¶
Overview ¶
Package golangmigrate provides a MigrationDriver backed by golang-migrate/migrate/v4.
Index ¶
- type Driver
- func (d *Driver) Down(ctx context.Context, req interfaces.MigrationRequest) (interfaces.MigrationResult, error)
- func (d *Driver) Force(_ context.Context, req interfaces.MigrationRequest, target string, ...) (interfaces.MigrationResult, error)
- func (d *Driver) Goto(_ context.Context, req interfaces.MigrationRequest, target string) (interfaces.MigrationResult, error)
- func (d *Driver) Name() string
- func (d *Driver) Status(_ context.Context, req interfaces.MigrationRequest) (interfaces.MigrationStatus, error)
- func (d *Driver) Up(ctx context.Context, req interfaces.MigrationRequest) (interfaces.MigrationResult, error)
- type ForceOptions
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Driver ¶
type Driver struct{}
Driver implements interfaces.MigrationDriver using golang-migrate.
func (*Driver) Down ¶
func (d *Driver) Down(ctx context.Context, req interfaces.MigrationRequest) (interfaces.MigrationResult, error)
Down rolls back N migrations (Options.Steps, default 1).
func (*Driver) Force ¶ added in v0.3.2
func (d *Driver) Force(_ context.Context, req interfaces.MigrationRequest, target string, opts ForceOptions) (interfaces.MigrationResult, error)
Force sets the recorded migration version without applying migration files.
func (*Driver) Goto ¶
func (d *Driver) Goto(_ context.Context, req interfaces.MigrationRequest, target string) (interfaces.MigrationResult, error)
Goto migrates to the specified version (up or down).
func (*Driver) Status ¶
func (d *Driver) Status(_ context.Context, req interfaces.MigrationRequest) (interfaces.MigrationStatus, error)
Status returns the current migration version and pending migrations.
func (*Driver) Up ¶
func (d *Driver) Up(ctx context.Context, req interfaces.MigrationRequest) (interfaces.MigrationResult, error)
Up applies all pending migrations.
type ForceOptions ¶ added in v0.3.2
type ForceOptions struct {
// AllowClean permits force-setting a database that is not currently dirty.
// Leave false for normal repair flows so force is limited to dirty states.
AllowClean bool
}
ForceOptions controls safety checks for metadata-only force repair.
Source Files
Click to show internal directories.
Click to hide internal directories.