migrations

Documentation

Index

• type Options
  • func (opts Options) Application(env anser.Environment, evgEnv evergreen.Environment) (*anser.Application, error)
  • func (opts Options) CustomApplication(env anser.Environment, conf *model.ConfigurationManualMigration) (*anser.Application, error)
  • func (opts Options) Setup(ctx context.Context) (anser.Environment, error)

Types

type Options

type Options struct {
	Limit    int
	Target   int
	Workers  int
	DryRun   bool
	IDs      []string
	Period   time.Duration
	Database string
	Session  db.Session
}

func (Options) Application

func (opts Options) Application(env anser.Environment, evgEnv evergreen.Environment) (*anser.Application, error)

Application is where the migrations are registered and defined, before being handed off to another calling environment for execution. See the anser documentation and the anser/example_test.go for an example.

func (Options) CustomApplication

func (opts Options) CustomApplication(env anser.Environment, conf *model.ConfigurationManualMigration) (*anser.Application, error)

func (Options) Setup

func (opts Options) Setup(ctx context.Context) (anser.Environment, error)

Setup configures the migration environment, configuring the backing queue and a database session.