migrator

Documentation

Index

• type Migrator
  • func NewMigrator(mongoClientOptions *options.ClientOptions, dbName, scriptDir string) (*Migrator, error)
  • func (m *Migrator) Down() error
  • func (m *Migrator) LatestVersion() (string, error)
  • func (m *Migrator) Up() error

Types

type Migrator

type Migrator struct {
	ScriptDir          string
	DBName             string
	MongoClientOptions *options.ClientOptions
	// contains filtered or unexported fields
}

func NewMigrator

func NewMigrator(mongoClientOptions *options.ClientOptions, dbName, scriptDir string) (*Migrator, error)

NewMigrator creates a new Migrator instance

func (*Migrator) Down

func (m *Migrator) Down() error

Down applies all down migrations in the scripts directory that have been applied

func (*Migrator) LatestVersion

func (m *Migrator) LatestVersion() (string, error)

LatestVersion retrieves the latest applied migration version from the database

func (*Migrator) Up

func (m *Migrator) Up() error

Up applies all up migrations in the scripts directory that haven't been applied yet