Class SqliteSaver

Hierarchy (View Summary)

BaseCheckpointSaver
- SqliteSaver

Index

Constructors

Properties

db isSetup serde withCheckpoint withoutCheckpoint

Methods

deleteThread get getNextVersion getTuple list migratePendingSends put putWrites setup fromConnString

Constructors

constructor

new SqliteSaver(db: Database, serde?: SerializerProtocol): SqliteSaver
Parameters
- db: Database
- Optionalserde: SerializerProtocol
Returns SqliteSaver
Overrides BaseCheckpointSaver.constructor
- Defined in checkpoint-sqlite/src/index.ts:125

Properties

db

db: Database

`Protected`isSetup

isSetup: boolean

serde

serde: SerializerProtocol

`Protected`withCheckpoint

withCheckpoint: Statement

`Protected`withoutCheckpoint

withoutCheckpoint: Statement

Methods

deleteThread

deleteThread(threadId: string): Promise<void>
Delete all checkpoints and writes associated with a specific thread ID.
Parameters
- threadId: string
  The thread ID whose checkpoints should be deleted.
Returns Promise<void>
Overrides BaseCheckpointSaver.deleteThread
- Defined in checkpoint-sqlite/src/index.ts:519

get

get(config: RunnableConfig): Promise<undefined | Checkpoint<string, string>>
Parameters
- config: RunnableConfig
Returns Promise<undefined | Checkpoint<string, string>>
Inherited from BaseCheckpointSaver.get
- Defined in checkpoint/dist/base.d.ts:61

getNextVersion

getNextVersion(current: undefined | number): number
Generate the next version ID for a channel.

Default is to use integer versions, incrementing by 1. If you override, you can use str/int/float versions, as long as they are monotonically increasing.
Parameters
- current: undefined | number
Returns number
Inherited from BaseCheckpointSaver.getNextVersion
- Defined in checkpoint/dist/base.d.ts:80

getTuple

getTuple(config: RunnableConfig): Promise<undefined | CheckpointTuple>
Parameters
- config: RunnableConfig
Returns Promise<undefined | CheckpointTuple>
Overrides BaseCheckpointSaver.getTuple
- Defined in checkpoint-sqlite/src/index.ts:171

list

list(
config: RunnableConfig,
options?: CheckpointListOptions,
): AsyncGenerator<CheckpointTuple>
Parameters
- config: RunnableConfig
- Optionaloptions: CheckpointListOptions
Returns AsyncGenerator<CheckpointTuple>
Overrides BaseCheckpointSaver.list
- Defined in checkpoint-sqlite/src/index.ts:253

`Protected`migratePendingSends

migratePendingSends(
    checkpoint: Checkpoint,
    threadId: string,
    parentCheckpointId: string,
): Promise<void>
Parameters
- checkpoint: Checkpoint
- threadId: string
- parentCheckpointId: string
Returns Promise<void>
- Defined in checkpoint-sqlite/src/index.ts:530

put

put(
    config: RunnableConfig,
    checkpoint: Checkpoint,
    metadata: CheckpointMetadata,
): Promise<RunnableConfig<Record<string, any>>>
Parameters
- config: RunnableConfig
- checkpoint: Checkpoint
- metadata: CheckpointMetadata
Returns Promise<RunnableConfig<Record<string, any>>>
Overrides BaseCheckpointSaver.put
- Defined in checkpoint-sqlite/src/index.ts:410

putWrites

putWrites(
    config: RunnableConfig,
    writes: PendingWrite[],
    taskId: string,
): Promise<void>
Store intermediate writes linked to a checkpoint.
Parameters
- config: RunnableConfig
- writes: PendingWrite[]
- taskId: string
Returns Promise<void>
Overrides BaseCheckpointSaver.putWrites
- Defined in checkpoint-sqlite/src/index.ts:469

`Protected`setup

setup(): void
Returns void
- Defined in checkpoint-sqlite/src/index.ts:135

`Static`fromConnString

fromConnString(connStringOrLocalPath: string): SqliteSaver
Parameters
- connStringOrLocalPath: string
Returns SqliteSaver
- Defined in checkpoint-sqlite/src/index.ts:131