postgres¶

Classes¶

PostgresStorageAdapter¶

Implements¶

StorageAdapter

Constructors¶

Constructor¶

new PostgresStorageAdapter(options): PostgresStorageAdapter;

Parameters¶

Parameter	Type
`options`	`PostgresStorageOptions`

Returns¶

PostgresStorageAdapter

Properties¶

options¶

readonly options: PostgresStorageOptions;

Methods¶

appendEvent()¶

appendEvent<TEvent>(event): Promise<RuntimeEvent>;

Type Parameters¶

Type Parameter
`TEvent` extends `RuntimeEventInput`

Parameters¶

Parameter	Type
`event`	`TEvent`

Returns¶

Promise\<RuntimeEvent>

Implementation of¶

StorageAdapter.appendEvent

appendEventIfApprovalPending()¶

appendEventIfApprovalPending<TEvent>(event): Promise<RuntimeEvent>;

Type Parameters¶

Type Parameter
`TEvent` extends `RuntimeEventInput`\<`"approval.resolved"`>

Parameters¶

Parameter	Type
`event`	`TEvent`

Returns¶

Promise\<RuntimeEvent>

Implementation of¶

StorageAdapter.appendEventIfApprovalPending

appendEventIfNoActiveVoiceSegment()¶

appendEventIfNoActiveVoiceSegment<TEvent>(event): Promise<RuntimeEvent>;

Type Parameters¶

Type Parameter
`TEvent` extends `RuntimeEventInput`\<`"voice.segment.started"`>

Parameters¶

Parameter	Type
`event`	`TEvent`

Returns¶

Promise\<RuntimeEvent>

Implementation of¶

StorageAdapter.appendEventIfNoActiveVoiceSegment

close()¶

close(): Promise<void>;

Returns¶

Promise\<void>

createConversation()¶

createConversation<TConversationContext>(input): Promise<ConversationRecord<TConversationContext>>;

Type Parameters¶

Type Parameter	Default type
`TConversationContext`	`unknown`

Parameters¶

Parameter	Type
`input`	`CreateConversationInput`\<`TConversationContext`>

Returns¶

Promise\<ConversationRecord\<TConversationContext>>

Implementation of¶

StorageAdapter.createConversation

getConversation()¶

getConversation<TConversationContext>(conversationId): Promise<ConversationRecord<TConversationContext>>;

Type Parameters¶

Type Parameter	Default type
`TConversationContext`	`unknown`

Parameters¶

Parameter	Type
`conversationId`	`string`

Returns¶

Promise\<ConversationRecord\<TConversationContext>>

Implementation of¶

StorageAdapter.getConversation

getSnapshot()¶

getSnapshot(conversationId): Promise<RuntimeSnapshot>;

Parameters¶

Parameter	Type
`conversationId`	`string`

Returns¶

Promise\<RuntimeSnapshot>

Implementation of¶

StorageAdapter.getSnapshot

initialize()¶

initialize(): Promise<void>;

Returns¶

Promise\<void>

Implementation of¶

StorageAdapter.initialize

listConversations()¶

listConversations<TConversationContext>(options?): Promise<ConversationRecord<TConversationContext>[]>;

Type Parameters¶

Type Parameter	Default type
`TConversationContext`	`unknown`

Parameters¶

Parameter	Type
`options?`	`ListConversationsOptions`

Returns¶

Promise\<ConversationRecord\<TConversationContext>[]>

Implementation of¶

StorageAdapter.listConversations

listEvents()¶

listEvents(options): Promise<RuntimeEvent[]>;

Parameters¶

Parameter	Type
`options`	`ListEventsOptions`

Returns¶

Promise\<RuntimeEvent[]>

Implementation of¶

StorageAdapter.listEvents

saveSnapshot()¶

saveSnapshot(snapshot): Promise<void>;

Parameters¶

Parameter	Type
`snapshot`	`RuntimeSnapshot`

Returns¶

Promise\<void>

Implementation of¶

StorageAdapter.saveSnapshot

updateConversationLifecycle()¶

updateConversationLifecycle(conversationId, lifecycle): Promise<ConversationRecord<unknown>>;

Parameters¶

Parameter	Type
`conversationId`	`string`
`lifecycle`	`ConversationLifecycle`

Returns¶

Promise\<ConversationRecord\<unknown>>

Implementation of¶

StorageAdapter.updateConversationLifecycle

Type Aliases¶

PostgresStorageClient¶

type PostgresStorageClient = Pool | Client;

PostgresStorageDatabase¶

type PostgresStorageDatabase = NodePgDatabase<typeof postgresStorageSchema>;

PostgresStorageOptions¶

type PostgresStorageOptions =
  | {
  client?: never;
  connection?: never;
  db?: never;
  url: string;
}
  | {
  client?: never;
  connection: string | PoolConfig;
  db?: never;
  url?: never;
}
  | {
  client: PostgresStorageClient;
  connection?: never;
  db?: never;
  url?: never;
}
  | {
  client?: never;
  connection?: never;
  db: PostgresStorageDatabase;
  url?: never;
};

Functions¶

createPostgresStorage()¶

function createPostgresStorage(options): PostgresStorageAdapter;

Parameters¶

Parameter	Type
`options`	`PostgresStorageOptions`

Returns¶

PostgresStorageAdapter