dlt.destinations.impl.synapse.synapse_adapter

TTableIndexType

Table index type used when creating the Synapse table. This regards indexes specified at the table level, not the column level.

synapse_adapter

def synapse_adapter(data: Any,
                    table_index_type: TTableIndexType = None) -> DltResource

View source on GitHub

Prepares data for the Synapse destination by specifying which table index type should be used.

Arguments:

• data Any - The data to be transformed. It can be raw data or an instance of DltResource. If raw data, the function wraps it into a DltResource object.
• table_index_type TTableIndexType, optional - The table index type used when creating the Synapse table.

Returns:

• DltResource - A resource with applied Synapse-specific hints.

Raises:

• ValueError - If input for table_index_type is invalid.

Examples:

    data = [{"name": "Anush", "description": "Integrations Hacker"}]
    synapse_adapter(data, table_index_type="clustered_columnstore_index")

[DltResource with hints applied]