GitHub

API reference for config.

Settings of PostgreSQL connections, pools and clients (Effect's PgConnection.Config, PgPool.Config, PgClientConfig and PgPoolConfig).

Each config extends the one before it: PgConnectionConfig opens one session, PgClientConfig adds what a client does with rows and identifiers, and PgPoolConfig adds the pool's limits. A pool reads only the connection and pool fields.

Connections go through libpq (psycopg), so TLS takes libpq's settings: ssl=True is sslmode=verify-full against the system's trusted CAs (sslrootcert=system, libpq 16 or later), ssl=False turns TLS off, and a mapping gives libpq's sslmode / sslrootcert / sslcert / sslkey / ... as they are (sslmode defaults to verify-full).

Types

TypeDefinitionDescription
Passwordtype Password = Redacted[str] | Effect[Redacted[str]]

A static password, or an effect run for each connection attempt.

Classes