migrator

Documentation

Index

• type Migration
• type MigrationType
• type Migrator
  • func NewMigrator() *Migrator
  • func (m *Migrator) Add(migration Migration)
  • func (m Migrator) ExecuteCommands(commands []string) (outputs []string, err error)
  • func (m *Migrator) GetValidMigrations(currentVersion string, migrationTypes ...MigrationType) (migrations []Migration)
  • func (m Migrator) IsValid(migrationVersion, currentVersion string) (bool, error)
  • func (m *Migrator) Run(currentVersion string, migrationTypes ...MigrationType) error

Types

type Migration

type Migration interface {
	Migrate() error
	Version() string
	Info() string
	Type() MigrationType
}

type MigrationType

type MigrationType int

MigrationType is migration type

const (
	// MigrationTypeClient is client migration type
	MigrationTypeClient MigrationType = iota + 1
	// MigrationTypeServer is server migration type
	MigrationTypeServer
)

type Migrator

type Migrator struct {
	Migrations []Migration
	Log        *zap.SugaredLogger
}

func NewMigrator

func NewMigrator() *Migrator

func (*Migrator) Add

func (m *Migrator) Add(migration Migration)

func (Migrator) ExecuteCommands

func (m Migrator) ExecuteCommands(commands []string) (outputs []string, err error)

func (*Migrator) GetValidMigrations

func (m *Migrator) GetValidMigrations(currentVersion string, migrationTypes ...MigrationType) (migrations []Migration)

func (Migrator) IsValid

func (m Migrator) IsValid(migrationVersion, currentVersion string) (bool, error)

IsValid checks if versions constraints are met, assuming that currentVersion is just updated version and it should be taken for migration

func (*Migrator) Run

func (m *Migrator) Run(currentVersion string, migrationTypes ...MigrationType) error