A session's settings and what the client does with them.
span_attributes: added to every statement's spantransform_result_names/transform_query_names: rename result columns / identifiers (fx.casehas the usual ones)transform_json: also rename the keys ofjsonvalues (on)on_acquire: runs in the fiber that takes a connection, once per statement outside a transaction and once perwith_transaction,reserve,listenandnotify; its finalizers run when that use ends. Services it needs come from where the client was built, overridden by the fiber's own.
Attributes#
| Attribute | Type | Description |
|---|---|---|
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 | |
transform_json | bool = True | |
on_acquire | Effect[None, Never, Any] | None = None |
Functions#
__init__#
__init__(*, url=None, host=None, port=None, path=None, ssl=None, database=None, username=None, password=None, connect_timeout=None, keep_alive=None, application_name=None, startup_parameters=dict[str, str](), startup_options=None, types=None, prepare=True, prepared_statement_cache_size=100, span_attributes=dict[str, object](), transform_result_names=None, transform_query_names=None, transform_json=True, on_acquire=None) -> None| Parameter | Type | Description |
|---|---|---|
url | Redacted[str] | None = None | |
host | str | None = None | |
port | int | None = None | |
path | str | None = None | |
ssl | bool | Mapping[str, str] | None = None | |
database | str | None = None | |
username | str | None = None | |
password | Password | None = None | |
connect_timeout | DurationInput | None = None | |
keep_alive | DurationInput | None = None | |
application_name | str | None = None | |
startup_parameters | Mapping[str, str] = dict[str, str]() | |
startup_options | str | None = None | |
types | AdaptersMap | None = None | |
prepare | bool = True | |
prepared_statement_cache_size | int = 100 | |
span_attributes | Mapping[str, object] = dict[str, object]() | |
transform_result_names | Callable[[str], str] | None = None | |
transform_query_names | Callable[[str], str] | None = None | |
transform_json | bool = True | |
on_acquire | Effect[None, Never, Any] | None = None |