migrate

Oct 25, 2022

Changes in this version

+ var DefaultOptions = &Options

+ var ErrMigrationIDDoesNotExist = errors.New("migrate: Tried to migrate to an ID that doesn't exist")

+ var ErrMissingID = errors.New("migrate: Missing ID in migration")

+ var ErrNoMigrationDefined = errors.New("migrate: No migration defined")

+ var ErrNoRunMigration = errors.New("migrate: Could not find last run migration")

+ var ErrPendingMigrationsFound = errors.New("migrate: Pending migrations exist, please run convoy migrate first")

+ var ErrRollbackImpossible = errors.New("migrate: It's impossible to rollback this migration")

+ var ErrUnknownPastMigration = errors.New("migrate: Found migration in DB that does not exist in code")

+ var Migrations = []*Migration

+ type DuplicatedIDError struct

+ ID string

+ func (e *DuplicatedIDError) Error() string

+ type InitSchemaFunc func(context.Context, *mongo.Database) (bool, error)

+ type MigrateFunc func(*mongo.Database) error

+ type Migration struct

+ ID string

+ Migrate MigrateFunc

+ Rollback RollbackFunc

+ type MigrationDoc struct

+ DocumentStatus datastore.DocumentStatus

+ ID string

+ type Migrator struct

+ func NewMigrator(c *mongo.Client, opts *Options, migrations []*Migration, i InitSchemaFunc) *Migrator

+ func (m *Migrator) CheckPendingMigrations(ctx context.Context) (bool, error)

+ func (m *Migrator) Migrate(ctx context.Context) error

+ func (m *Migrator) MigrateTo(ctx context.Context, migrationID string) error

+ func (m *Migrator) RollbackLast(ctx context.Context) error

+ func (m *Migrator) RollbackTo(ctx context.Context, migrationID string) error

+ type Options struct

+ CollectionName string

+ DatabaseName string

+ UseTransaction bool

+ ValidateUnknownMigrations bool

+ type RollbackFunc func(*mongo.Database) error