migrate

Documentation

Index

• func ApplyAll(ctx context.Context, url string) (int, error)
• func Down(ctx context.Context, url, targetName string) (int, error)
• func DumpMigrations(dest string) error
• func LatestID() string
• func Names() []string
• func Up(ctx context.Context, url, targetName string) (int, error)
• func VerifyAll(ctx context.Context, url string) error
• func VerifyIsLatest(ctx context.Context, url string) error

Functions

func ApplyAll

func ApplyAll(ctx context.Context, url string) (int, error)

ApplyAll will atomically perform all UP migrations.

func Down

func Down(ctx context.Context, url, targetName string) (int, error)

Down will roll back all migrations up to, but NOT including, targetName.

If the DB contains unknown migrations, err is returned.

func DumpMigrations

func DumpMigrations(dest string) error

DumpMigrations will attempt to write all migration files to the specified directory

func LatestID

func LatestID() string

LatestID will return the ID of the latest migration.

func Names

func Names() []string

Names will return all AssetNames without the timestamps and extensions

func Up

func Up(ctx context.Context, url, targetName string) (int, error)

Up will apply all migrations up to, and including, targetName. If targetName is empty, all available migrations are applied.

func VerifyAll

func VerifyAll(ctx context.Context, url string) error

VerifyAll will verify all migrations have already been applied.

func VerifyIsLatest

func VerifyIsLatest(ctx context.Context, url string) error

VerifyIsLatest will verify the latest migration is the same as the latest available migration.

This ensures the DB isn't newer than the currently running code.