MigrationRunner

Executes individual migration files within optional transaction contexts.

Index

Constructors

• constructor

Methods

• run
• setMasterMigration
• setRunSchema
• unsetMasterMigration
• unsetRunSchema

Constructors

constructor

• new MigrationRunner(driver, options, config): MigrationRunner

• Parameters

  • driver: AbstractSqlDriver<AbstractSqlConnection, AbstractSqlPlatform>

  • options: MigrationsOptions

  • config: Configuration<IDatabaseDriver<Connection>, EntityManager<IDatabaseDriver<Connection>>>

  Returns MigrationRunner

Methods

run

• run(migration, method, afterRun): Promise<void>

• Parameters

  • migration: Migration

  • method: up | down

  • optionalafterRun: (tx) => Promise<void>

  Returns Promise<void>

setMasterMigration

• setMasterMigration(trx): void

• Parameters

  • trx: any

  Returns void

setRunSchema

• setRunSchema(schema): void

• Parameters

  • optionalschema: string

  Returns void

unsetMasterMigration

• unsetMasterMigration(): void

• Returns void

unsetRunSchema

• unsetRunSchema(): void

• Returns void