Migrator

Implements

• IMigrator

Index

Constructors

• constructor

Methods

• checkMigrationNeeded
• createInitialMigration
• createMigration
• down
• getExecutedMigrations
• getPendingMigrations
• off
• on
• up
• register

Constructors

constructor

• new Migrator(em: SqlEntityManager<AbstractSqlDriver<AbstractSqlConnection, AbstractSqlPlatform>>): Migrator

• Parameters

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

  Returns Migrator

Methods

checkMigrationNeeded

• checkMigrationNeeded(): Promise<boolean>

• Implementation of IMigrator.checkMigrationNeeded

  Checks current schema for changes.

  ---

  Returns Promise<boolean>

createInitialMigration

• createInitialMigration(path?: string, name?: string, blank?: boolean): Promise<MigrationResult>

• Implementation of IMigrator.createInitialMigration

  Creates initial migration. This generates the schema based on metadata, and checks whether all the tables are already present. If yes, it will also automatically log the migration as executed. Initial migration can be created only if the schema is already aligned with the metadata, or when no schema is present - in such case regular migration would have the same effect.

  ---

  Parameters

  • optionalpath: string

  • optionalname: string

  • blank: boolean = false

  Returns Promise<MigrationResult>

createMigration

• createMigration(path?: string, blank?: boolean, initial?: boolean, name?: string): Promise<MigrationResult>

• Implementation of IMigrator.createMigration

  Checks current schema for changes, generates new migration if there are any.

  ---

  Parameters

  • optionalpath: string

  • blank: boolean = false

  • initial: boolean = false

  • optionalname: string

  Returns Promise<MigrationResult>

down

• down(options?: string | string[] | MigrateOptions): Promise<UmzugMigration[]>

• Implementation of IMigrator.down

  Executes down migrations to the given point. Without parameter it will migrate one version down.

  ---

  Parameters

  • optionaloptions: string | string[] | MigrateOptions

  Returns Promise<UmzugMigration[]>

getExecutedMigrations

• getExecutedMigrations(): Promise<MigrationRow[]>

• Implementation of IMigrator.getExecutedMigrations

  Returns list of already executed migrations.

  ---

  Returns Promise<MigrationRow[]>

getPendingMigrations

• getPendingMigrations(): Promise<UmzugMigration[]>

• Implementation of IMigrator.getPendingMigrations

  Returns list of pending (not yet executed) migrations found in the migration directory.

  ---

  Returns Promise<UmzugMigration[]>

off

• off(eventName: MigratorEvent, listener: (event: UmzugMigration) => MaybePromise<void>): this

• Implementation of IMigrator.off

  Removes event handler.

  ---

  Parameters

  • eventName: MigratorEvent

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

  Returns this

on

• on(eventName: MigratorEvent, listener: (event: UmzugMigration) => MaybePromise<void>): this

• Implementation of IMigrator.on

  Registers event handler.

  ---

  Parameters

  • eventName: MigratorEvent

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

  Returns this

up

• up(options?: string | string[] | MigrateOptions): Promise<UmzugMigration[]>

• Implementation of IMigrator.up

  Executes specified migrations. Without parameter it will migrate up to the latest version.

  ---

  Parameters

  • optionaloptions: string | string[] | MigrateOptions

  Returns Promise<UmzugMigration[]>

staticregister

• register(orm: MikroORM<IDatabaseDriver<Connection>, EntityManager<IDatabaseDriver<Connection>>>): void

• Parameters

  • orm: MikroORM<IDatabaseDriver<Connection>, EntityManager<IDatabaseDriver<Connection>>>

  Returns void