migrations

Documentation

Index

• Variables
• func NewInMemoryMigratedDatabase(t *testing.T, dbName string) (*sql.DB, error)
• type MigrationRunner
  • func NewMigrationRunner(migrationsFsys fs.FS, migrationsPath string, appStore datastore.AppStore, ...) (*MigrationRunner, error)
  • func (runner *MigrationRunner) RunSafe() error

Variables

var DefaultMigrationsFs embed.FS

Functions

func NewInMemoryMigratedDatabase

func NewInMemoryMigratedDatabase(t *testing.T, dbName string) (*sql.DB, error)

Types

type MigrationRunner

type MigrationRunner struct {
	// contains filtered or unexported fields
}

func NewMigrationRunner

func NewMigrationRunner(migrationsFsys fs.FS, migrationsPath string, appStore datastore.AppStore, logger zerolog.Logger) (*MigrationRunner, error)

func (*MigrationRunner) RunSafe

func (runner *MigrationRunner) RunSafe() error

RunSafe runs migrations if necessary: new migrations are available and the database is not dirty. It returns the current version of the database or an error. If an error occurs, the database is restored to its previous state.