dlt.destinations.impl.synapse.factory

synapse Objects

class synapse(Destination[SynapseClientConfiguration, "SynapseClient"])

View source on GitHub

__init__

def __init__(credentials: Union[SynapseCredentials, Dict[str, Any],
                                str] = None,
             default_table_index_type: TTableIndexType = "heap",
             create_indexes: bool = False,
             staging_use_msi: bool = False,
             has_case_sensitive_identifiers: bool = False,
             destination_name: str = None,
             environment: str = None,
             **kwargs: Any) -> None

View source on GitHub

Configure the Synapse destination to use in a pipeline.

All arguments provided here supersede other configuration sources such as environment variables and dlt config files.

Arguments:

• credentials Union[SynapseCredentials, Dict[str, Any], str], optional - Credentials to connect to the Synapse dedicated pool. Can be an instance of SynapseCredentials or a connection string in the format synapse://user:password@host:port/database
• default_table_index_type TTableIndexType - Maps directly to the default_table_index_type attribute of the SynapseClientConfiguration object.
• create_indexes bool, optional - Maps directly to the create_indexes attribute of the SynapseClientConfiguration object.
• staging_use_msi bool, optional - Maps directly to the staging_use_msi attribute of the SynapseClientConfiguration object.
• has_case_sensitive_identifiers bool, optional - Are identifiers used by synapse database case sensitive (following the catalog collation)
• destination_name str, optional - Name of the destination. Defaults to None.
• environment str, optional - Environment name. Defaults to None.
• **kwargs Any, optional - Additional arguments passed to the destination config