Skip to content

DataLakeDatasetSchema

Source code in docs_src/capo_supplychain/types/data_lake_dataset_schema.py
class DataLakeDatasetSchema(TypedDict, closed=True):
    name: (
        "capo_supplychain.types.data_lake_dataset_schema_name.DataLakeDatasetSchemaName"
    )
    """<p>The name of the dataset schema.</p>"""
    fields: "capo_supplychain.types.data_lake_dataset_schema_field_list.DataLakeDatasetSchemaFieldList"
    """<p>The list of field details of the dataset schema.</p>"""
    primary_keys: NotRequired[
        "capo_supplychain.types.data_lake_dataset_primary_key_field_list.DataLakeDatasetPrimaryKeyFieldList"
    ]
    """<p>The list of primary key fields for the dataset. Primary keys defined can help data ingestion methods to ensure data uniqueness: CreateDataIntegrationFlow's dedupe strategy will leverage primary keys to perform records deduplication before write to dataset; SendDataIntegrationEvent's UPSERT and DELETE can only work with dataset with primary keys. For more details, refer to those data ingestion documentations.</p> <p>Note that defining primary keys does not necessarily mean the dataset cannot have duplicate records, duplicate records can still be ingested if CreateDataIntegrationFlow's dedupe disabled or through SendDataIntegrationEvent's APPEND operation.</p>"""

fields instance-attribute

The list of field details of the dataset schema.

name instance-attribute

The name of the dataset schema.

primary_keys instance-attribute

primary_keys: NotRequired[DataLakeDatasetPrimaryKeyFieldList]

The list of primary key fields for the dataset. Primary keys defined can help data ingestion methods to ensure data uniqueness: CreateDataIntegrationFlow's dedupe strategy will leverage primary keys to perform records deduplication before write to dataset; SendDataIntegrationEvent's UPSERT and DELETE can only work with dataset with primary keys. For more details, refer to those data ingestion documentations.

Note that defining primary keys does not necessarily mean the dataset cannot have duplicate records, duplicate records can still be ingested if CreateDataIntegrationFlow's dedupe disabled or through SendDataIntegrationEvent's APPEND operation.