Skip to main content

Interface: MigrationPlan

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

The description of a migration plan, as planned and understood by the Depot Migration engine. This is a JSON document that is stored in S3 and sent over EventBridge to the migration engine. It is permissible to alter this plan to perform custom migration steps, but the resulting plan must still conform to this type definition.

Properties​

dataset​

readonly dataset: DatasetDescriptor

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

the identity of the dataset this plan applies to

environment​

readonly environment: EnvironmentDescriptor

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

the identity of the environment this plan applies to

formatWarning?​

readonly optional formatWarning?: string

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

an indication of the MigrationPlan format version. As long as there aren't consumers of migration plans outside of Depot (e.g. plan interceptors deployed by services), this format may change at any time. Please contact the Island team if you plan to perform plan transforms.

location​

readonly location: LocationDescriptor

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

the identity of the location hosting the dataset this plan applies to

metadata?​

readonly optional metadata?: Metadata

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

The metadata describing the correspondence between depot schema and field names to the database object and column names. This is only supplied by the planning phase to assist migration plan transformers into generating additional sql steps, and is unnecessary and ignored by the Depot Asynchronous Migration Engine when the adjusted plan is read back.

migrationId​

readonly migrationId: string

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

the identifier of the migration this plan describes

phases​

readonly phases: MigrationPlanPhase[]

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

the migration phases

summary​

readonly summary: MigrationPlanSummary

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

a brief summary of the contents of the plan