dlt.destinations.impl.mssql.factory

mssql Objects

class mssql(Destination[MsSqlClientConfiguration, "MsSqlJobClient"])

View source on GitHub

__init__

def __init__(credentials: Union[MsSqlCredentials, Dict[str, Any], str] = None,
             create_indexes: bool = False,
             has_case_sensitive_identifiers: bool = False,
             destination_name: str = None,
             environment: str = None,
             **kwargs: Any) -> None

View source on GitHub

Configure the MsSql 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[MsSqlCredentials, Dict[str, Any], str], optional - Credentials to connect to the mssql database. Can be an instance of MsSqlCredentials or a connection string in the format mssql://user:password@host:port/database
• create_indexes bool, optional - Should unique indexes be created
• has_case_sensitive_identifiers bool, optional - Are identifiers used by mssql database case sensitive (following the collation)
• destination_name str, optional - Name of the destination, can be used in config section to differentiate between multiple of the same type
• environment str, optional - Environment of the destination
• **kwargs Any - Additional arguments passed to the destination config