Skip to main content

Interface: StageDepotDatasetProps

Defined in: packages/depot-cdk/src/stage-depot-dataset.ts:84

Dataset properties to pass to the Dataset construct.

Properties​

additionalSchemas?​

readonly optional additionalSchemas?: StageDepotDatasetAdditionalSchemas[]

Defined in: packages/depot-cdk/src/stage-depot-dataset.ts:98

Additional schemas to include for the Dataset.

auth?​

readonly optional auth?: Auth

Defined in: packages/depot-cdk/src/stage-depot-dataset.ts:113

The authentication configuration for the Dataset.

dependencies?​

readonly optional dependencies?: DatasetDependency[]

Defined in: packages/depot-cdk/src/stage-depot-dataset.ts:92

List of dependencies for the Dataset.

deploymentGroup?​

readonly optional deploymentGroup?: boolean

Defined in: packages/depot-cdk/src/stage-depot-dataset.ts:134

Whether to use a Deployment Group for the Dataset during cdk deploy operations or not.

environment​

readonly environment: IStageDepotEnvironment

Defined in: packages/depot-cdk/src/stage-depot-dataset.ts:89

Reference to a Depot Environment

executor?​

readonly optional executor?: IExecutor

Defined in: packages/depot-cdk/src/stage-depot-dataset.ts:107

Executor reference for the Dataset.

Deprecated​

Use executors instead

executors?​

readonly optional executors?: DatasetExecutor[]

Defined in: packages/depot-cdk/src/stage-depot-dataset.ts:110

List of executors for the Dataset, each specifying the executor and operation which it should be used for.

history?​

readonly optional history?: StageDepotHistoryProps

Defined in: packages/depot-cdk/src/stage-depot-dataset.ts:131

History properties for the Dataset.

location​

readonly location: ILocation

Defined in: packages/depot-cdk/src/stage-depot-dataset.ts:101

The location to use for the Dataset. Can be a direct location, or a composite location

migrateMaterializedViews?​

readonly optional migrateMaterializedViews?: boolean

Defined in: packages/depot-cdk/src/stage-depot-dataset.ts:142

Deprecated​

use StageDepotDatasetProps#migrationOptions#migrateMaterializedViews instead

migrationOptions?​

readonly optional migrationOptions?: StageDepotDatasetMigrationOptions

Defined in: packages/depot-cdk/src/stage-depot-dataset.ts:147

name​

readonly name: string

Defined in: packages/depot-cdk/src/stage-depot-dataset.ts:86

Dataset name or alias

notifications?​

readonly optional notifications?: StageDepotNotificationsProps

Defined in: packages/depot-cdk/src/stage-depot-dataset.ts:116

The notifications configuration for the Dataset.

package​

readonly package: DeploymentPackage

Defined in: packages/depot-cdk/src/stage-depot-dataset.ts:95

The package to use for the Dataset, specifying schemas and versions.

permissions?​

readonly optional permissions?: DepotPermissions

Defined in: packages/depot-cdk/src/stage-depot-dataset.ts:128

Permissions for the Dataset. Will be overwritten if Schema-level permissions within the Dataset are configured.

s3tables?​

readonly optional s3tables?: StageDepotDatasetS3TablesProps

Defined in: packages/depot-cdk/src/stage-depot-dataset.ts:150

S3 Tables namespace configuration. Only applies when the Dataset's location is an S3 Tables location.

seeding?​

readonly optional seeding?: StageDepotDatasetSeedingProps

Defined in: packages/depot-cdk/src/stage-depot-dataset.ts:137

Seeding properties for Dataset.

sqlDatabaseOverride?​

readonly optional sqlDatabaseOverride?: string

Defined in: packages/depot-cdk/src/stage-depot-dataset.ts:125

An optional overridden database name to use for the Dataset's SQL-backed storage location

subscriptions?​

readonly optional subscriptions?: StageDepotSubscriptionsProps

Defined in: packages/depot-cdk/src/stage-depot-dataset.ts:119

The subscriptions configuration for the Dataset.

tags?​

readonly optional tags?: Record<string, string>

Defined in: packages/depot-cdk/src/stage-depot-dataset.ts:122

Custom tags to add to the Dataset construct

useTransactionLog?​

readonly optional useTransactionLog?: boolean

Defined in: packages/depot-cdk/src/stage-depot-dataset.ts:145

Whether to log transactions in Depot transaction log