Class Migrator`Abstract`

Manages single-run patches/migrations.

Hierarchy

Migrator
- DatabaseMigrator

Index

Constructors

Properties

bus injector migrations

Methods

applied apply applying filterAppliedMigrations filterPendingMigrations getAllMigrationIdentifiers getLastApplyGroup has initialize markApplied migrate rollback rolledBack rollingBack undo unmarkApplied

Constructors

constructor

new Migrator(): Migrator
Returns Migrator

Properties

`Protected` `Readonly` bus

bus: Bus<Event>

`Protected` `Readonly` injector

injector: Container

`Protected` `Readonly` migrations

migrations: Migrations

Methods

`Protected` applied

applied(migration: Migration): Promise<void>
Protected
Fire the AppliedMigrationEvent.
Parameters
- migration: Migration
Returns Promise<void>
- Defined in src/orm/migrations/Migrator.ts:231

apply

apply(migration: Migration): Promise<void>
Apply a single migration.
Parameters
- migration: Migration
Returns Promise<void>
- Defined in src/orm/migrations/Migrator.ts:146

`Protected` applying

applying(migration: Migration): Promise<void>
Protected
Fire the ApplyingMigrationEvent.
Parameters
- migration: Migration
Returns Promise<void>
- Defined in src/orm/migrations/Migrator.ts:221

`Protected` filterAppliedMigrations

filterAppliedMigrations(identifiers: string[]): Promise<string[]>
Protected
Given a list of migration identifiers, filter out those that have been applied.
Parameters
- identifiers: string[]
Returns Promise<string[]>
- Defined in src/orm/migrations/Migrator.ts:195

`Protected` filterPendingMigrations

filterPendingMigrations(identifiers: string[]): Promise<string[]>
Protected
Given a list of migration identifiers, filter out those that have not been applied.
Parameters
- identifiers: string[]
Returns Promise<string[]>
- Defined in src/orm/migrations/Migrator.ts:208

`Protected` getAllMigrationIdentifiers

getAllMigrationIdentifiers(): string[]
Protected
Get all registered migrations, by their string-form identifiers.

Returns string[]
- Defined in src/orm/migrations/Migrator.ts:174

`Abstract` getLastApplyGroup

getLastApplyGroup(): Awaitable<string[]>
Get the identifiers of the last group of migrations that were applied.

Returns Awaitable<string[]>
- Defined in src/orm/migrations/Migrator.ts:52

`Abstract` has

has(migration: Migration): Awaitable<boolean>
Should resolve true if the given migration has already been applied.
Parameters
- migration: Migration
Returns Awaitable<boolean>
- Defined in src/orm/migrations/Migrator.ts:30

initialize

initialize(): Awaitable<void>
Do any initial setup required to get the migrator ready. This can be overridden by implementation classes to do any necessary setup.

Returns Awaitable<void>
- Defined in src/orm/migrations/Migrator.ts:58

`Abstract` markApplied

markApplied(migrations: Migration | Migration[], date?: Date): Awaitable<void>
Should mark the given migrations as being applied.

If a date is specified, then that is the timestamp when the migrations were applied, otherwise, use new Date().
Parameters
- migrations: Migration | Migration[]
- Optional date: Date
Returns Awaitable<void>
- Defined in src/orm/migrations/Migrator.ts:41

migrate

migrate(identifiers?: string[]): Promise<void>
Apply pending migrations.

If identifiers are specified, only the pending migrations with those identifiers are applied. If none are specified, all pending migrations will be applied.
Parameters
- Optional identifiers: string[]
Returns Promise<void>
- Defined in src/orm/migrations/Migrator.ts:69

rollback

rollback(identifiers?: string[]): Promise<void>
Rollback applied migrations.

If specified, only applied migrations with the given identifiers will be rolled back. If not specified, then the last "batch" of applied migrations will be rolled back.
Parameters
- Optional identifiers: string[]
Returns Promise<void>
- Defined in src/orm/migrations/Migrator.ts:110

`Protected` rolledBack

rolledBack(migration: Migration): Promise<void>
Protected
Fire the RolledBackMigrationEvent.
Parameters
- migration: Migration
Returns Promise<void>
- Defined in src/orm/migrations/Migrator.ts:251

`Protected` rollingBack

rollingBack(migration: Migration): Promise<void>
Protected
Fire the RollingBackMigrationEvent.
Parameters
- migration: Migration
Returns Promise<void>
- Defined in src/orm/migrations/Migrator.ts:241

undo

undo(migration: Migration): Promise<void>
Rollback a single migration.
Parameters
- migration: Migration
Returns Promise<void>
- Defined in src/orm/migrations/Migrator.ts:160

`Abstract` unmarkApplied

unmarkApplied(migration: Migration | Migration[]): Awaitable<void>
Should un-mark the given migrations as being applied.
Parameters
- migration: Migration | Migration[]
Returns Awaitable<void>
- Defined in src/orm/migrations/Migrator.ts:47