How to open a session.
url: a libpq URI (postgres://orpostgresql://); the fields below win over what it sayshost/port/path: where to connect; ahoststarting with/is a socket directory, apatha socket file named.s.PGSQL.<port>ssl: see the module docs; from the URL'ssslmodewhen unsetdatabase/username(default:$USER) /passwordconnect_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: overridesstartup_parametersand the URL (default"pyfect")startup_parameters: session defaults (SET-able settings) for every session;startup_options: libpq'soptions, as they aretypes: a psycopgAdaptersMapwith the session's own dumpers and loaders (Effect'sPgTypes.Registry)prepare/prepared_statement_cache_size: keep up to that many statements prepared per session (on, 100)
Attributes#
| Attribute | 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] = field(default_factory=(dict[str, str])) | |
startup_options | str | None = None | |
types | AdaptersMap | None = None | |
prepare | bool = True | |
prepared_statement_cache_size | int = 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| 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 |