Class PostgresSessionStore<TSnapshot>

Postgres-backed durable session store with tenant scoping and indexed lookup.

Example

const store = PostgresSessionStore.fromEnv();
await store.ensureSchema();

Type Parameters

TSnapshot extends { messages: unknown[]; totalCostUSD: number }

Implements

SessionStore<TSnapshot>

Index

Constructors

constructor

Methods

fromEnv close delete get list set ensureSchema

Constructors

constructor

new PostgresSessionStore<
TSnapshot extends { messages: unknown[]; totalCostUSD: number },
>(
options?: PostgresSessionStoreOptions,
): PostgresSessionStore<TSnapshot>
Type Parameters
- TSnapshot extends { messages: unknown[]; totalCostUSD: number }
Parameters
- options: PostgresSessionStoreOptions = {}
Returns PostgresSessionStore<TSnapshot>
- Defined in src/session-store.ts:201

Methods

`Static`fromEnv

fromEnv<TSnapshot extends { messages: unknown[]; totalCostUSD: number }>(
options?: Omit<PostgresSessionStoreOptions, "connectionString">,
): PostgresSessionStore<TSnapshot>
Type Parameters
- TSnapshot extends { messages: unknown[]; totalCostUSD: number }
Parameters
- options: Omit<PostgresSessionStoreOptions, "connectionString"> = {}
Returns PostgresSessionStore<TSnapshot>
- Defined in src/session-store.ts:209

close

close(): Promise<void>
Returns Promise<void>
- Defined in src/session-store.ts:219

delete

delete(sessionId: string, tenantId?: string): Promise<void>
Parameters
- sessionId: string
- OptionaltenantId: string
Returns Promise<void>
Implementation of SessionStore.delete
- Defined in src/session-store.ts:229

get

get(
sessionId: string,
tenantId?: string,
): Promise<SessionRecord<TSnapshot> | null>
Parameters
- sessionId: string
- OptionaltenantId: string
Returns Promise<SessionRecord<TSnapshot> | null>
Implementation of SessionStore.get
- Defined in src/session-store.ts:238

list

list(options?: SessionStoreListOptions): Promise<SessionMeta[]>
Parameters
- options: SessionStoreListOptions = {}
Returns Promise<SessionMeta[]>
Implementation of SessionStore.list
- Defined in src/session-store.ts:261

set

set(
    sessionId: string,
    snapshot: TSnapshot,
    options?: SessionStoreSetOptions,
): Promise<SessionRecord<TSnapshot>>
Parameters
- sessionId: string
- snapshot: TSnapshot
- options: SessionStoreSetOptions = {}
Returns Promise<SessionRecord<TSnapshot>>
Implementation of SessionStore.set
- Defined in src/session-store.ts:277

ensureSchema

ensureSchema(): Promise<void>
Returns Promise<void>
- Defined in src/session-store.ts:330

Class PostgresSessionStore<TSnapshot>

Example

Type Parameters

Implements

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns PostgresSessionStore<TSnapshot>

Methods

`Static`fromEnv

Type Parameters

Parameters

Returns PostgresSessionStore<TSnapshot>

close

Returns Promise<void>

delete

Parameters

Returns Promise<void>

get

Parameters

Returns Promise<SessionRecord<TSnapshot> | null>

list

Parameters

Returns Promise<SessionMeta[]>

set

Parameters

Returns Promise<SessionRecord<TSnapshot>>

ensureSchema

Returns Promise<void>

Settings

On This Page

Class PostgresSessionStore<TSnapshot>

Example

Type Parameters

Implements

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns PostgresSessionStore<TSnapshot>

Methods

StaticfromEnv

Type Parameters

Parameters

Returns PostgresSessionStore<TSnapshot>

close

Returns Promise<void>

delete

Parameters

Returns Promise<void>

get

Parameters

Returns Promise<SessionRecord<TSnapshot> | null>

list

Parameters

Returns Promise<SessionMeta[]>

set

Parameters

Returns Promise<SessionRecord<TSnapshot>>

ensureSchema

Returns Promise<void>

Settings

On This Page

`Static`fromEnv