IMigrator

Interface for the migrator, responsible for creating and executing database migrations.

Index

Methods

• checkSchema
• create
• createInitial
• down
• getExecuted
• getPending
• logMigration
• off
• on
• rollup
• unlogMigration
• up

Methods

checkSchema

• checkSchema(): Promise<boolean>

• Checks current schema for changes.

  ---

  Returns Promise<boolean>

create

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

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

  ---

  Parameters

  • optionalpath: string

  • optionalblank: boolean

  • optionalinitial: boolean

  • optionalname: string

  Returns Promise<MigrationResult>

createInitial

• createInitial(path): Promise<MigrationResult>

• 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

  Returns Promise<MigrationResult>

down

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

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

  ---

  Parameters

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

  Returns Promise<MigrationInfo[]>

getExecuted

• getExecuted(options): Promise<MigrationRow[]>

• Returns list of already executed migrations.

  ---

  Parameters

  • optionaloptions: { schema?: string }

  • optionalschema: string

  Returns Promise<MigrationRow[]>

getPending

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

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

  ---

  Parameters

  • optionaloptions: { schema?: string }

  • optionalschema: string

  Returns Promise<MigrationInfo[]>

logMigration

• logMigration(name): Promise<void>

• Marks a migration as executed without actually running it.

  ---

  Parameters

  • name: string

  Returns Promise<void>

off

• off(event, listener): IMigrator

• Removes event handler.

  ---

  Parameters

  • event: MigratorEvent

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

  Returns IMigrator

on

• on(event, listener): IMigrator

• Registers event handler.

  ---

  Parameters

  • event: MigratorEvent

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

  Returns IMigrator

rollup

• rollup(migrations): Promise<MigrationResult>

• Combines multiple executed migrations into a single migration file. Concatenates source code without touching the database schema.

  ---

  Parameters

  • optionalmigrations: string[]

  Returns Promise<MigrationResult>

unlogMigration

• unlogMigration(name): Promise<void>

• Removes a migration from the executed list without reverting it.

  ---

  Parameters

  • name: string

  Returns Promise<void>

up

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

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

  ---

  Parameters

  • optionaloptions: string | string[] | MigrateOptions

  Returns Promise<MigrationInfo[]>