GitHub

MssqlClientConfig

API reference for MssqlClientConfig.

How to connect, and what the client does with values and names.

  • server / port (1433) / instance_name (found through the SQL Server Browser; not with port) / database / username / password: a SQL Server login
  • encrypt: TLS for the whole session (default); False encrypts the login only, when the server allows it
  • trust_server: accept the server's certificate without checking it
  • connect_timeout: the connection and login of one connection (15 seconds), and the client's first SELECT 1 (5 seconds when unset)
  • cancel_timeout: how long an interrupted statement's cancel may take before its connection is closed (5 seconds)
  • connection_retry_interval / max_retries_on_transient_errors: retries of a login failing with a transient error (0.5 seconds, 3)
  • min_connections (1) / max_connections (10) / connection_ttl (45 minutes from a connection's creation): the pool
  • parameter_types: the type each kind of value is sent as (default_parameter_types)
  • span_attributes: added to every statement's span
  • transform_result_names / transform_query_names: rename result columns / identifiers (fx.case has the usual ones)

Attributes

AttributeTypeDescription
serverstr
portint | None = None
instance_namestr | None = None
databasestr | None = None
usernamestr | None = None
passwordRedacted[str] | None = None
encryptbool = True
trust_serverbool = False
connect_timeoutDurationInput | None = None
cancel_timeoutDurationInput | None = None
connection_retry_intervalDurationInput | None = None
max_retries_on_transient_errorsint | None = None
min_connectionsint | None = None
max_connectionsint | None = None
connection_ttlDurationInput | None = None
parameter_typesParameterTypes = field(default_factory=(lambda: default_parameter_types))
span_attributesMapping[str, object] = field(default_factory=(dict[str, object]))
transform_result_namesCallable[[str], str] | None = None
transform_query_namesCallable[[str], str] | None = None

Functions

__init__

__init__(*, server, port=None, instance_name=None, database=None, username=None, password=None, encrypt=True, trust_server=False, connect_timeout=None, cancel_timeout=None, connection_retry_interval=None, max_retries_on_transient_errors=None, min_connections=None, max_connections=None, connection_ttl=None, parameter_types=(lambda: default_parameter_types)(), span_attributes=dict[str, object](), transform_result_names=None, transform_query_names=None) -> None
ParameterTypeDescription
serverstr
portint | None = None
instance_namestr | None = None
databasestr | None = None
usernamestr | None = None
passwordRedacted[str] | None = None
encryptbool = True
trust_serverbool = False
connect_timeoutDurationInput | None = None
cancel_timeoutDurationInput | None = None
connection_retry_intervalDurationInput | None = None
max_retries_on_transient_errorsint | None = None
min_connectionsint | None = None
max_connectionsint | None = None
connection_ttlDurationInput | None = None
parameter_typesParameterTypes = (lambda: default_parameter_types)()
span_attributesMapping[str, object] = dict[str, object]()
transform_result_namesCallable[[str], str] | None = None
transform_query_namesCallable[[str], str] | None = None