Documentation
¶
Index ¶
- Variables
- type DuplicatedIDError
- type InitSchemaFunc
- type MigrateFunc
- type Migration
- type MigrationDoc
- type 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
- type RollbackFunc
Constants ¶
This section is empty.
Variables ¶
View Source
var ( DefaultOptions = &Options{ DatabaseName: "convoy", CollectionName: "data_migrations", ValidateUnknownMigrations: true, UseTransaction: true, } // ErrRollbackImpossible is returned when trying to rollback a migration // that has no rollback function. ErrRollbackImpossible = errors.New("migrate: It's impossible to rollback this migration") // ErrNoMigrationDefined is returned when no migration is defined. ErrNoMigrationDefined = errors.New("migrate: No migration defined") // ErrMissingID is returned when the ID of the migration is equal to "" ErrMissingID = errors.New("migrate: Missing ID in migration") // ErrNoRunMigration is returned when any run migration was found while // running RollbackLast ErrNoRunMigration = errors.New("migrate: Could not find last run migration") // ErrUnknownPastMigration is returned if a migration exists in the DB that doesn't exist in the code ErrUnknownPastMigration = errors.New("migrate: Found migration in DB that does not exist in code") // ErrMigrationIDDoesNotExist is returned when migrating or rolling back to a migration ID that // does not exist in the list of migrations ErrMigrationIDDoesNotExist = errors.New("migrate: Tried to migrate to an ID that doesn't exist") // ErrPendingMigrationsFound is used to indicate there exist pending migrations yet to be run // if the user proceeds without running migrations it can lead to data integrity issues. ErrPendingMigrationsFound = errors.New("migrate: Pending migrations exist, please run convoy migrate first") )
Functions ¶
This section is empty.
Types ¶
type DuplicatedIDError ¶
type DuplicatedIDError struct {
ID string
}
DuplicatedIDError is returned when more than one migration have the same ID
func (*DuplicatedIDError) Error ¶
func (e *DuplicatedIDError) Error() string
type MigrateFunc ¶
type Migration ¶
type Migration struct {
// ID is the migration identifier. Usually a timestamp like "201601021504".
ID string
// Migrate is a function that will br executed while running this migration.
Migrate MigrateFunc
// Rollback will be executed on rollback. Can be nil.
Rollback RollbackFunc
}
type MigrationDoc ¶
type MigrationDoc struct {
ID string `json:"id" bson:"id"`
}
type Migrator ¶
type Migrator struct {
// contains filtered or unexported fields
}
func NewMigrator ¶
func (*Migrator) CheckPendingMigrations ¶
func (*Migrator) MigrateTo ¶
MigrateTo executes all migrations that did not run yet up to the migration that matches `migrationID`.
func (*Migrator) RollbackLast ¶
RollbackLast undo the last migration
type Options ¶
type Options struct {
// DatabaseName is the name of the database to connect.
DatabaseName string
// CollectionName is the migration table.
CollectionName string
// ValidateUnknownMigrations will cause migrate to fail if there are unknown migration
// IDs in the database
ValidateUnknownMigrations bool
// UseTransaction executes migrations inside a single transaction.
UseTransaction bool
}
type RollbackFunc ¶
Source Files
Click to show internal directories.
Click to hide internal directories.