Class DatabaseMigrator

Migrator implementation that tracks applied migrations in a database table.

todo: allow configuring more of this

Hierarchy

Migrator
- DatabaseMigrator

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new DatabaseMigrator(): DatabaseMigrator

Inherited from Migrator.constructor

Returns DatabaseMigrator

Properties

Protected Readonly bus

Protected Readonly db

db: DatabaseService

Protected initialized

initialized: boolean = false

True if we've initialized the migrator.

Protected Readonly injector

injector: Container

Protected Readonly migrations

migrations: Migrations

Methods

Protected applied

applied(migration: Migration): Promise<void>

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

Parameters
- migration: Migration
Returns Promise<void>

apply

apply(migration: Migration): Promise<void>

Inherited from Migrator.apply
- 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>

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

Parameters
- migration: Migration
Returns Promise<void>

Protected builder

builder(): Builder

- Defined in src/orm/migrations/DatabaseMigrator.ts:176
Get a query builder instance.

Returns Builder

Protected filterAppliedMigrations

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

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

override

to make this more efficient

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

Protected filterPendingMigrations

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

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

override

to make this more efficient

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

Protected getAllMigrationIdentifiers

getAllMigrationIdentifiers(): string[]

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

Returns string[]

getLastApplyGroup

getLastApplyGroup(): Promise<string[]>

Overrides Migrator.getLastApplyGroup
- Defined in src/orm/migrations/DatabaseMigrator.ts:97
Returns Promise<string[]>

Protected getNextGroupIdentifier

getNextGroupIdentifier(): Promise<number>

- Defined in src/orm/migrations/DatabaseMigrator.ts:125
Helper method to look up the next applygroup that should be used.

Returns Promise<number>

has

has(migration: Migration): Promise<boolean>

Overrides Migrator.has
- Defined in src/orm/migrations/DatabaseMigrator.ts:54
Parameters
- migration: Migration
Returns Promise<boolean>

initialize

initialize(): Promise<void>

Overrides Migrator.initialize
- Defined in src/orm/migrations/DatabaseMigrator.ts:23
Returns Promise<void>

markApplied

markApplied(migrations: Migration | Migration[], applyDate?: Date): Promise<void>

Overrides Migrator.markApplied
- Defined in src/orm/migrations/DatabaseMigrator.ts:63
Parameters
- migrations: Migration | Migration[]
- applyDate: Date = ...
Returns Promise<void>

migrate

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

Inherited from Migrator.migrate
- 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>

Inherited from Migrator.rollback
- 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>

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

Parameters
- migration: Migration
Returns Promise<void>

Protected rollingBack

rollingBack(migration: Migration): Promise<void>

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

Parameters
- migration: Migration
Returns Promise<void>

undo

undo(migration: Migration): Promise<void>

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

Parameters
- migration: Migration
Returns Promise<void>

unmarkApplied

unmarkApplied(migrations: Migration | Migration[]): Promise<void>

Overrides Migrator.unmarkApplied
- Defined in src/orm/migrations/DatabaseMigrator.ts:83
Parameters
- migrations: Migration | Migration[]
Returns Promise<void>

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

Extollo is a free & libre application framework in TypeScript.