GitHub

PgPoolConfig

API reference for PgPoolConfig.

A client's settings and its pool's limits.

  • min_connections / max_connections: the pool's size (0 to 10)
  • idle_timeout: connections above the minimum close after this long unused (60 seconds)
  • connection_ttl: replace a connection this long after it opened (each is used at least once, so 0 means never reuse)
  • acquire_timeout: bound waiting for a connection, opening one included (unbounded)

Attributes

AttributeTypeDescription
min_connectionsint = 0
max_connectionsint = 10
idle_timeoutDurationInput = '60 seconds'
connection_ttlDurationInput | None = None
acquire_timeoutDurationInput | 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, min_connections=0, max_connections=10, idle_timeout='60 seconds', connection_ttl=None, acquire_timeout=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
min_connectionsint = 0
max_connectionsint = 10
idle_timeoutDurationInput = '60 seconds'
connection_ttlDurationInput | None = None
acquire_timeoutDurationInput | None = None