Class: Migration#
migrations.Migration
Hierarchy#
- Migration
Constructors#
constructor#
+ new Migration(driver: AbstractSqlDriver<AbstractSqlConnection>, config: Configuration<IDatabaseDriver<Connection>>): Migration
Parameters:#
| Name | Type |
|---|---|
driver | AbstractSqlDriver<AbstractSqlConnection> |
config | Configuration<IDatabaseDriver<Connection>> |
Returns: Migration
Defined in: packages/migrations/src/Migration.ts:9
Properties#
config#
• Protected Readonly config: Configuration<IDatabaseDriver<Connection>>
ctx#
• Protected Optional ctx: undefined | Transaction<any, any>
Defined in: packages/migrations/src/Migration.ts:9
driver#
• Protected Readonly driver: AbstractSqlDriver<AbstractSqlConnection>
queries#
• Private Readonly queries: Query[]
Defined in: packages/migrations/src/Migration.ts:8
Methods#
addSql#
â–¸ addSql(sql: Query): void
Parameters:#
| Name | Type |
|---|---|
sql | Query |
Returns: void
Defined in: packages/migrations/src/Migration.ts:24
down#
â–¸ down(): Promise<void>
Returns: Promise<void>
Defined in: packages/migrations/src/Migration.ts:16
execute#
â–¸ execute(sql: Query): Promise<EntityData<AnyEntity<any>>[]>
Parameters:#
| Name | Type |
|---|---|
sql | Query |
Returns: Promise<EntityData<AnyEntity<any>>[]>
Defined in: packages/migrations/src/Migration.ts:37
getKnex#
â–¸ getKnex(): Knex<any, unknown[]>
Returns: Knex<any, unknown[]>
Defined in: packages/migrations/src/Migration.ts:41
getQueries#
â–¸ getQueries(): Query[]
Returns: Query[]
Defined in: packages/migrations/src/Migration.ts:45
isTransactional#
â–¸ isTransactional(): boolean
Returns: boolean
Defined in: packages/migrations/src/Migration.ts:20
reset#
â–¸ reset(): void
Returns: void
Defined in: packages/migrations/src/Migration.ts:28
setTransactionContext#
â–¸ setTransactionContext(ctx: any): void
Parameters:#
| Name | Type |
|---|---|
ctx | any |
Returns: void
Defined in: packages/migrations/src/Migration.ts:33
up#
â–¸ Abstractup(): Promise<void>
Returns: Promise<void>
Defined in: packages/migrations/src/Migration.ts:14