Skip to main content
Version: 1.9.1

MSSQLConn

class MSSQLConn(
connection_string_or_uri: str,
credentials: UserPasswordCredentials | None = None,
enforce_connection_params: bool = True,
cx_src_configs_mssql: dict | None = None,
cx_dst_configs_mssql: dict | None = None,
)

Bases: Conn

Categories: connections

Represents a connection configuration to Microsoft SQL Server (MSSQL).

Initialize a MSSQLConn instance.

Parameters

parameter
connection_string_or_uri

The connection string or URI for the MSSQL database.

parameter
enforce_connection_params

Whether to enforce connection parameters for the MSSQL connection. Applicable only for a connection to a MSSQL Destination. Defaults to True.

parameter
cx_src_configs_mssql

Source-specific configuration parameters for the MSSQL connection. Defaults to None.

parameter
cx_dst_configs_mssql

Destination-specific configuration parameters for the MSSQL connection. Defaults to None.

Properties

property
connection_string_or_uristr

The connection string or URI for the MSSQL database.

property
credentialsUserPasswordCredentials | None

The credentials used to authenticate with the database.

property
cx_dst_configs_mssqldict

The destination configuration parameters for the MSSQL connection.

property
cx_src_configs_mssqldict

The source configuration parameters for the MSSQL connection.

property
enforce_connection_paramsbool

Whether to enforce connection parameters for the MSSQL connection. Applicable only for a connection to a MSSQL Destination.

property
uristr

The URI for the MSSQL database.