Skip to main content
Version: 2.x

Interface: PostgresConnectionOptions

Defined in: javascript/src/shared/postgres-client.ts:62

PostgreSQL deadline, pool, and observability controls.

Extended by​

Properties​

applicationName?​

optional applicationName?: string

Defined in: javascript/src/shared/postgres-client.ts:76

PostgreSQL application_name. Defaults to bursar-js.

connectionTimeoutMs?​

optional connectionTimeoutMs?: number

Defined in: javascript/src/shared/postgres-client.ts:66

Time allowed to establish or acquire a connection. Defaults to 10 seconds.

idleTimeoutMs?​

optional idleTimeoutMs?: number

Defined in: javascript/src/shared/postgres-client.ts:72

Idle pooled connection lifetime. Uses pg's default when omitted.

idleTransactionTimeoutMs?​

optional idleTransactionTimeoutMs?: number

Defined in: javascript/src/shared/postgres-client.ts:70

Server-side idle transaction deadline. Defaults to 30 seconds; set 0 to disable.

instrumentation?​

optional instrumentation?: Instrumentation

Defined in: javascript/src/shared/postgres-client.ts:80

Optional vendor-neutral instrumentation. Defaults to Bursar's no-op registry.

maxConnections?​

optional maxConnections?: number

Defined in: javascript/src/shared/postgres-client.ts:74

Maximum connections in an SDK-owned pool. Uses pg's default when omitted.

onPoolError?​

optional onPoolError?: (error) => void

Defined in: javascript/src/shared/postgres-client.ts:78

Receives typed errors emitted by idle pool clients. Must not throw.

Parameters​

error​

BursarError

Returns​

void

providerEnvironment?​

optional providerEnvironment?: "live" | "test" | "sandbox"

Defined in: javascript/src/shared/postgres-client.ts:64

Financial provider namespace. Low-level credit-only clients default to live.

statementTimeoutMs?​

optional statementTimeoutMs?: number

Defined in: javascript/src/shared/postgres-client.ts:68

Server-side statement deadline. Defaults to 30 seconds; set 0 to disable.