Interface PostgresClientOptions

interface PostgresClientOptions {
    application_name?: string;
    connectionString?: string;
    connectionTimeoutMillis?: number;
    database?: string;
    host?: string;
    idleTimeoutMillis?: number;
    keepAlive?: boolean;
    keepAliveInitialDelayMillis?: number;
    max?: number;
    password?: string;
    port?: number;
    ssl?: boolean | Record<string, unknown>;
    user?: string;
}

Hierarchy (view full)

Properties

application_name? connectionString? connectionTimeoutMillis? database? host? idleTimeoutMillis? keepAlive? keepAliveInitialDelayMillis? max? password? port? ssl? user?

Properties

Optionalapplication_name

application_name?: string

Reported in pg_stat_activity.application_name.

OptionalconnectionString

connectionString?: string

OptionalconnectionTimeoutMillis

connectionTimeoutMillis?: number

Milliseconds to wait for a connection before failing (pg default: forever).

Optionaldatabase

database?: string

Optionalhost

host?: string

OptionalidleTimeoutMillis

idleTimeoutMillis?: number

OptionalkeepAlive

keepAlive?: boolean

Enable TCP keepalive on the socket.

OptionalkeepAliveInitialDelayMillis

keepAliveInitialDelayMillis?: number

Idle time before the first TCP keepalive probe.

Optionalmax

max?: number

Optionalpassword

password?: string

Optionalport

port?: number

Optionalssl

ssl?: boolean | Record<string, unknown>

Optionaluser

user?: string

Settings

Member Visibility

On This Page

Properties