How to connect, and what the client does with values and names.
server/port(1433) /instance_name(found through the SQL Server Browser; not withport) /database/username/password: a SQL Server loginencrypt: TLS for the whole session (default);Falseencrypts the login only, when the server allows ittrust_server: accept the server's certificate without checking itconnect_timeout: the connection and login of one connection (15 seconds), and the client's firstSELECT 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 poolparameter_types: the type each kind of value is sent as (default_parameter_types)span_attributes: added to every statement's spantransform_result_names/transform_query_names: rename result columns / identifiers (fx.casehas the usual ones)
Attributes#
| Attribute | Type | Description |
|---|---|---|
server | str | |
port | int | None = None | |
instance_name | str | None = None | |
database | str | None = None | |
username | str | None = None | |
password | Redacted[str] | None = None | |
encrypt | bool = True | |
trust_server | bool = False | |
connect_timeout | DurationInput | None = None | |
cancel_timeout | DurationInput | None = None | |
connection_retry_interval | DurationInput | None = None | |
max_retries_on_transient_errors | int | None = None | |
min_connections | int | None = None | |
max_connections | int | None = None | |
connection_ttl | DurationInput | None = None | |
parameter_types | ParameterTypes = field(default_factory=(lambda: default_parameter_types)) | |
span_attributes | Mapping[str, object] = field(default_factory=(dict[str, object])) | |
transform_result_names | Callable[[str], str] | None = None | |
transform_query_names | Callable[[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| Parameter | Type | Description |
|---|---|---|
server | str | |
port | int | None = None | |
instance_name | str | None = None | |
database | str | None = None | |
username | str | None = None | |
password | Redacted[str] | None = None | |
encrypt | bool = True | |
trust_server | bool = False | |
connect_timeout | DurationInput | None = None | |
cancel_timeout | DurationInput | None = None | |
connection_retry_interval | DurationInput | None = None | |
max_retries_on_transient_errors | int | None = None | |
min_connections | int | None = None | |
max_connections | int | None = None | |
connection_ttl | DurationInput | None = None | |
parameter_types | ParameterTypes = (lambda: default_parameter_types)() | |
span_attributes | Mapping[str, object] = dict[str, object]() | |
transform_result_names | Callable[[str], str] | None = None | |
transform_query_names | Callable[[str], str] | None = None |