GitHub

PgConnectionConfig

API reference for PgConnectionConfig.

How to open a session.

  • url: a libpq URI (postgres:// or postgresql://); the fields below win over what it says
  • host / port / path: where to connect; a host starting with / is a socket directory, a path a socket file named .s.PGSQL.<port>
  • ssl: see the module docs; from the URL's sslmode when unset
  • database / username (default: $USER) / password
  • connect_timeout: bounds the password, the connection and authentication (5 seconds)
  • keep_alive: idle time before TCP keepalive probes start (whole seconds, at least one)
  • application_name: overrides startup_parameters and the URL (default "pyfect")
  • startup_parameters: session defaults (SET-able settings) for every session; startup_options: libpq's options, as they are
  • types: a psycopg AdaptersMap with the session's own dumpers and loaders (Effect's PgTypes.Registry)
  • prepare / prepared_statement_cache_size: keep up to that many statements prepared per session (on, 100)

Attributes

AttributeTypeDescription
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] = field(default_factory=(dict[str, str]))
startup_optionsstr | None = None
typesAdaptersMap | None = None
preparebool = True
prepared_statement_cache_sizeint = 100

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) -> 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