GitHub

PgClientConfig

API reference for PgClientConfig.

A session's settings and what the client does with them.

  • span_attributes: added to every statement's span
  • transform_result_names / transform_query_names: rename result columns / identifiers (fx.case has the usual ones)
  • transform_json: also rename the keys of json values (on)
  • on_acquire: runs in the fiber that takes a connection, once per statement outside a transaction and once per with_transaction, reserve, listen and notify; its finalizers run when that use ends. Services it needs come from where the client was built, overridden by the fiber's own.

Attributes

AttributeTypeDescription
span_attributesMapping[str, object] = field(default_factory=(dict[str, object]))
transform_result_namesCallable[[str], str] | None = None
transform_query_namesCallable[[str], str] | None = None
transform_jsonbool = True
on_acquireEffect[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
ParameterTypeDescription
urlRedacted[str] | None = None
hoststr | None = None
portint | None = None
pathstr | None = None
sslbool | Mapping[str, str] | None = None
databasestr | None = None
usernamestr | None = None
passwordPassword | None = None
connect_timeoutDurationInput | None = None
keep_aliveDurationInput | None = None
application_namestr | None = None
startup_parametersMapping[str, str] = dict[str, str]()
startup_optionsstr | None = None
typesAdaptersMap | None = None
preparebool = True
prepared_statement_cache_sizeint = 100
span_attributesMapping[str, object] = dict[str, object]()
transform_result_namesCallable[[str], str] | None = None
transform_query_namesCallable[[str], str] | None = None
transform_jsonbool = True
on_acquireEffect[None, Never, Any] | None = None