Skip to content
LlamaIndex TypeScript API Reference

PostgresKVStoreClientConfig

PostgresKVStoreClientConfig = { clientConfig?: pg.ClientConfig; } | { shouldConnect?: boolean; client?: pg.Client | pg.PoolClient; }

Defined in: .build/typescript/packages/providers/storage/postgres/src/PostgresKVStore.ts:16

Type Declaration

Section titled “Type Declaration”

{ clientConfig?: pg.ClientConfig; }

clientConfig?

Section titled “clientConfig?”

optional clientConfig: pg.ClientConfig

Client configuration options for the pg client.

PostgresSQL Client API

{ shouldConnect?: boolean; client?: pg.Client | pg.PoolClient; }

shouldConnect?

Section titled “shouldConnect?”

optional shouldConnect: boolean

A pg client or pool client instance. If provided, make sure it is not connected to the database yet, or it will throw an error.

client?

Section titled “client?”

optional client: pg.Client | pg.PoolClient