Skip to main content
Version: 2.x

Interface: PostgresBillingStoreOptions

Defined in: javascript/src/billing/postgres/store.ts:138

Extends​

Properties​

applicationName?​

optional applicationName?: string

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

PostgreSQL application_name. Defaults to bursar-js.

Inherited from​

PostgresStoreOptions.applicationName

billingPayloadBackend?​

optional billingPayloadBackend?: "postgres" | "s3"

Defined in: javascript/src/billing/postgres/store.ts:150

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.

Inherited from​

PostgresStoreOptions.connectionTimeoutMs

idleTimeoutMs?​

optional idleTimeoutMs?: number

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

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

Inherited from​

PostgresStoreOptions.idleTimeoutMs

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.

Inherited from​

PostgresStoreOptions.idleTransactionTimeoutMs

instrumentation?​

optional instrumentation?: Instrumentation

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

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

Inherited from​

PostgresStoreOptions.instrumentation

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.

Inherited from​

PostgresStoreOptions.maxConnections

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

Inherited from​

PostgresStoreOptions.onPoolError

poolConstructor?​

optional poolConstructor?: PostgresPoolConstructor

Defined in: javascript/src/billing/postgres/store.ts:149

Injectable pg.Pool constructor for custom runtimes and tests.

postgres​

postgres: string | PostgresPool

Defined in: javascript/src/billing/postgres/store.ts:143

PostgreSQL connection string or an application-owned pool.

providerEnvironment​

providerEnvironment: "live" | "test" | "sandbox"

Defined in: javascript/src/billing/postgres/store.ts:147

Explicit financial namespace; billing stores never guess live vs test.

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.

Inherited from​

PostgresStoreOptions.statementTimeoutMs

tenantId​

tenantId: string

Defined in: javascript/src/billing/postgres/store.ts:145

Tenant UUID bound to every store transaction.