migrate

type Migration ¶

type Migration struct {
	Version     uint64
	Description string
	Up          MigrationFunc
	Down        MigrationFunc
}

Migration represents single engine migration. Migration contains:

- version: migration version, must be unique in migration list

- description: text description of migration

- up: callback which will be called in "up" migration process

- down: callback which will be called in "down" migration process for reverting changes

type MigrationFunc ¶

type MigrationFunc func(ctx context.Context, engine elasticx.Engine) error

MigrationFunc is used to define actions to be performed for a migration.

type Migrations ¶ added in v0.0.50

type Migrations []Migration

func (m Migrations) Sort()

type Migrator ¶

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

Migrate is type for performing migrations in provided database. Database versioned using dedicated collection. Each migration applying ("up" and "down") adds new document to collection. This document consists migration version, migration description and timestamp. Current database version determined as version in latest added document (biggest "_key") from collection mentioned above.

func NewMigrator(opts NewMigratorOptions) *Migrator

func (m *Migrator) Down(ctx context.Context, targetVersion int) error

func (m *Migrator) SetMigrationsIndex(name string)

func (m *Migrator) Up(ctx context.Context, targetVersion int) error

func (m *Migrator) Version(ctx context.Context) (migrationVersionInfo, error)

type NewMigratorOptions ¶ added in v0.0.32

type NewMigratorOptions struct {
	Engine     elasticx.Engine
	Package    string
	Migrations Migrations
}