Skip to main content

IQMigration

@quik/database


@quik/database / IQMigration

Interface: IQMigration

Defined in: database/src/migrations/QMigration.ts:14

Methods

down()

down(schema, engine): Promise<void | SchemaBuilder>

Defined in: database/src/migrations/QMigration.ts:29

Reverts the migration to rollback changes made to the database schema.

Parameters

schema

SchemaBuilder

The Knex schema builder instance

engine

MigrationConnection

The Knex connection or transaction instance

Returns

Promise<void | SchemaBuilder>


up()

up(schema, engine): Promise<void | SchemaBuilder>

Defined in: database/src/migrations/QMigration.ts:21

Applies the migration to update the database schema.

Parameters

schema

SchemaBuilder

The Knex schema builder instance

engine

MigrationConnection

The Knex connection or transaction instance

Returns

Promise<void | SchemaBuilder>