Migrator

Hierarchy

• AbstractMigrator<AbstractSqlDriver>
  • Migrator

Index

Constructors

• constructor

Methods

• checkSchema
• create
• createInitial
• down
• getExecuted
• getPending
• getStorage
• off
• on
• up
• register

Constructors

constructor

• new Migrator(em): Migrator

• Overrides AbstractMigrator<AbstractSqlDriver>.constructor

  Parameters

  • em: SqlEntityManager<AbstractSqlDriver<AbstractSqlConnection, AbstractSqlPlatform>>

  Returns Migrator

Methods

checkSchema

• checkSchema(): Promise<boolean>

• Overrides AbstractMigrator.checkSchema

  Returns Promise<boolean>

create

• create(path, blank, initial, name): Promise<MigrationResult>

• Overrides AbstractMigrator.create

  @inheritDoc

  ---

  Parameters

  • optionalpath: string

  • blank: boolean = false

  • initial: boolean = false

  • optionalname: string

  Returns Promise<MigrationResult>

createInitial

• createInitial(path, name, blank): Promise<MigrationResult>

• Overrides AbstractMigrator.createInitial

  @inheritDoc

  ---

  Parameters

  • optionalpath: string

  • optionalname: string

  • blank: boolean = false

  Returns Promise<MigrationResult>

inheriteddown

• down(options): Promise<MigrationInfo[]>

• Inherited from AbstractMigrator.down

  @inheritDoc

  ---

  Parameters

  • optionaloptions: string | string[] | Omit<MigrateOptions, from>

  Returns Promise<MigrationInfo[]>

inheritedgetExecuted

• getExecuted(): Promise<MigrationRow[]>

• Inherited from AbstractMigrator.getExecuted

  @inheritDoc

  ---

  Returns Promise<MigrationRow[]>

inheritedgetPending

• getPending(): Promise<MigrationInfo[]>

• Inherited from AbstractMigrator.getPending

  @inheritDoc

  ---

  Returns Promise<MigrationInfo[]>

getStorage

• getStorage(): MigrationStorage

• Overrides AbstractMigrator.getStorage

  Returns MigrationStorage

inheritedoff

• off(eventName, listener): this

• Inherited from AbstractMigrator.off

  @inheritDoc

  ---

  Parameters

  • eventName: MigratorEvent

  • listener: (event) => MaybePromise<void>

  Returns this

inheritedon

• on(eventName, listener): this

• Inherited from AbstractMigrator.on

  @inheritDoc

  ---

  Parameters

  • eventName: MigratorEvent

  • listener: (event) => MaybePromise<void>

  Returns this

inheritedup

• up(options): Promise<MigrationInfo[]>

• Inherited from AbstractMigrator.up

  @inheritDoc

  ---

  Parameters

  • optionaloptions: string | string[] | MigrateOptions

  Returns Promise<MigrationInfo[]>

staticregister

• register(orm): void

• Parameters

  • orm: MikroORM<IDatabaseDriver<Connection>, EntityManager<IDatabaseDriver<Connection>>, (string | EntityClass<Partial<any>> | EntitySchema<any, never, EntityCtor<any>>)[]>

  Returns void