Class Migrator

Manages single-run patches/migrations.

Hierarchy

Migrator
- DatabaseMigrator

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Migrator(): Migrator

Returns Migrator

Properties

Protected Readonly bus

Protected Readonly injector

injector: Container

Protected Readonly migrations

migrations: Migrations

Methods

Protected applied

applied(migration: Migration): Promise<void>

- Defined in src/orm/migrations/Migrator.ts:271
Fire the AppliedMigrationEvent.

Parameters
- migration: Migration
Returns Promise<void>

apply

apply(migration: Migration): Promise<void>

- Defined in src/orm/migrations/Migrator.ts:146
Apply a single migration.

Parameters
- migration: Migration
Returns Promise<void>

Protected applying

applying(migration: Migration): Promise<void>

- Defined in src/orm/migrations/Migrator.ts:261
Fire the ApplyingMigrationEvent.

Parameters
- migration: Migration
Returns Promise<void>

Protected filterAppliedMigrations

filterAppliedMigrations(identifiers: string[]): Promise<string[]>

- Defined in src/orm/migrations/Migrator.ts:195
Given a list of migration identifiers, filter out those that have been applied.

Parameters
- identifiers: string[]
Returns Promise<string[]>

Protected filterPendingMigrations

filterPendingMigrations(identifiers: string[]): Promise<string[]>

- Defined in src/orm/migrations/Migrator.ts:228
Given a list of migration identifiers, filter out those that have not been applied.

Parameters
- identifiers: string[]
Returns Promise<string[]>

Protected getAllMigrationIdentifiers

getAllMigrationIdentifiers(): string[]

- Defined in src/orm/migrations/Migrator.ts:174
Get all registered migrations, by their string-form identifiers.

Returns string[]

Abstract getLastApplyGroup

getLastApplyGroup(): Awaitable<string[]>

- Defined in src/orm/migrations/Migrator.ts:52
Get the identifiers of the last group of migrations that were applied.

Returns Awaitable<string[]>

Abstract has

has(migration: Migration): Awaitable<boolean>

- Defined in src/orm/migrations/Migrator.ts:30
Should resolve true if the given migration has already been applied.

Parameters
- migration: Migration
Returns Awaitable<boolean>

initialize

initialize(): Awaitable<void>

- Defined in src/orm/migrations/Migrator.ts:58
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>

Abstract markApplied

markApplied(migrations: Migration | Migration[], date?: Date): Awaitable<void>

- Defined in src/orm/migrations/Migrator.ts:41
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>

migrate

migrate(identifiers?: string[]): Promise<void>

- Defined in src/orm/migrations/Migrator.ts:69
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>

rollback

rollback(identifiers?: string[]): Promise<void>

- Defined in src/orm/migrations/Migrator.ts:110
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>

Protected rolledBack

rolledBack(migration: Migration): Promise<void>

- Defined in src/orm/migrations/Migrator.ts:291
Fire the RolledBackMigrationEvent.

Parameters
- migration: Migration
Returns Promise<void>

Protected rollingBack

rollingBack(migration: Migration): Promise<void>

- Defined in src/orm/migrations/Migrator.ts:281
Fire the RollingBackMigrationEvent.

Parameters
- migration: Migration
Returns Promise<void>

undo

undo(migration: Migration): Promise<void>

- Defined in src/orm/migrations/Migrator.ts:160
Rollback a single migration.

Parameters
- migration: Migration
Returns Promise<void>

Abstract unmarkApplied

unmarkApplied(migration: Migration | Migration[]): Awaitable<void>

- Defined in src/orm/migrations/Migrator.ts:47
Should un-mark the given migrations as being applied.

Parameters
- migration: Migration | Migration[]
Returns Awaitable<void>

extollo (v. latin) - to lift up, to elevate

Extollo is a free & libre application framework in TypeScript.