Skip to main content

Interface: SqlDeferredStep

Defined in: packages/depot-cdk/src/stage-depot-migration-types.ts:358

A SQL step executed using "deferred" or "fire and forget" semantics. This step is expected to return immediately or nearly immediately, and start a background process within the database engine, whose effects are desirable but may be acceptably delayed.

In Postgres / Aurora RDS, this is typically used for DDL statements with the CONCURRENTLY option.

Extends​

Properties​

sql​

readonly sql: string

Defined in: packages/depot-cdk/src/stage-depot-migration-types.ts:363

The SQL statement to execute

target​

readonly target: string

Defined in: packages/depot-cdk/src/stage-depot-migration-types.ts:334

The Depot logical name of the schema being operated on

Inherited from​

SqlMigrationStepBase.target

type​

readonly type: "sqlDeferred"

Defined in: packages/depot-cdk/src/stage-depot-migration-types.ts:359