Skip to main content

Interface: SchemaMetadata

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

A record describing all the naming correspondences between the logical names used within Depot and their concrete translation within the database.

Properties​

fromFields​

readonly fromFields: FieldNamePair[]

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

The field name correspondences as they exist in the old version of the schema

fromVersion?​

readonly optional fromVersion?: number

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

The version of the schema within the "old" state of the dataset

name​

readonly name: SchemaMetadataName

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

The translation pair from the Depot logical name to the database name

toFields​

readonly toFields: FieldNamePair[]

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

The field name correspondences as they exist in the new version of the schema

toVersion?​

readonly optional toVersion?: number

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

The version of the schema within the "new" state of the dataset