Class Migration

Abstract base-class for one-time migrations.

Hierarchy

Migration

Index

Constructors

constructor

Properties

migrationIdentifier

Accessors

identifier

Methods

Constructors

constructor

new Migration(): Migration

Returns Migration

Properties

Protected migrationIdentifier

migrationIdentifier: string

Set by the Migrations unit on load.

Accessors

identifier

get identifier(): string

- Defined in src/orm/migrations/Migration.ts:26
Get the unique identifier of this migration.

Returns string

Methods

Abstract down

down(): Awaitable<void>

- Defined in src/orm/migrations/Migration.ts:38
Undo the migration.

Returns Awaitable<void>

setMigrationIdentifier

setMigrationIdentifier(name: string): void

- Defined in src/orm/migrations/Migration.ts:19
Sets the migration identifier. This is used internally when the Migrations service loads the migration files to determine the ID from the file-name. It shouldn't be used externally.

Parameters
- name: string
Returns void

Abstract up

up(): Awaitable<void>

- Defined in src/orm/migrations/Migration.ts:33
Apply the migration.

Returns Awaitable<void>

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

Extollo is a free & libre application framework in TypeScript.