MigrationStorage

Implements

• UmzugStorage

Index

Constructors

• constructor

Methods

• ensureTable
• executed
• getExecutedMigrations
• logMigration
• setMasterMigration
• unlogMigration
• unsetMasterMigration

Constructors

constructor

• new MigrationStorage(driver: AbstractSqlDriver<AbstractSqlConnection, AbstractSqlPlatform>, options: MigrationsOptions): MigrationStorage

• Parameters

  • driver: AbstractSqlDriver<AbstractSqlConnection, AbstractSqlPlatform>

  • options: MigrationsOptions

  Returns MigrationStorage

Methods

ensureTable

• ensureTable(): Promise<void>

• Returns Promise<void>

executed

• executed(): Promise<string[]>

• Implementation of UmzugStorage.executed

  Gets list of executed migrations.

  ---

  Returns Promise<string[]>

getExecutedMigrations

• getExecutedMigrations(): Promise<MigrationRow[]>

• Returns Promise<MigrationRow[]>

logMigration

• logMigration(params: MigrationParams<any>): Promise<void>

• Implementation of UmzugStorage.logMigration

  Logs migration to be considered as executed.

  ---

  Parameters

  • params: MigrationParams<any>

  Returns Promise<void>

setMasterMigration

• setMasterMigration(trx: any): void

• Parameters

  • trx: any

  Returns void

unlogMigration

• unlogMigration(params: MigrationParams<any>): Promise<void>

• Implementation of UmzugStorage.unlogMigration

  Unlogs migration (makes it to be considered as pending).

  ---

  Parameters

  • params: MigrationParams<any>

  Returns Promise<void>

unsetMasterMigration

• unsetMasterMigration(): void

• Returns void