Class MongoDBSaver

A LangGraph checkpoint saver backed by a MongoDB database.

Hierarchy (View Summary)

BaseCheckpointSaver
- MongoDBSaver

Index

Constructors

Properties

checkpointCollectionName checkpointWritesCollectionName client db serde

Methods

deleteThread get getNextVersion getTuple list put putWrites

Constructors

constructor

new MongoDBSaver(
__namedParameters: MongoDBSaverParams,
serde?: SerializerProtocol,
): MongoDBSaver
Parameters
- __namedParameters: MongoDBSaverParams
- Optionalserde: SerializerProtocol
Returns MongoDBSaver
Overrides BaseCheckpointSaver.constructor
- Defined in checkpoint-mongodb/src/index.ts:33

Properties

checkpointCollectionName

checkpointCollectionName: string = "checkpoints"

checkpointWritesCollectionName

checkpointWritesCollectionName: string = "checkpoint_writes"

`Protected`client

client: MongoClient

`Protected`db

db: Db

serde

serde: SerializerProtocol

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-mongodb/src/index.ts:304

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>
Retrieves a checkpoint from the MongoDB database based on the provided config. If the config contains a "checkpoint_id" key, the checkpoint with the matching thread ID and checkpoint ID is retrieved. Otherwise, the latest checkpoint for the given thread ID is retrieved.
Parameters
- config: RunnableConfig
Returns Promise<undefined | CheckpointTuple>
Overrides BaseCheckpointSaver.getTuple
- Defined in checkpoint-mongodb/src/index.ts:57

list

list(
config: RunnableConfig,
options?: CheckpointListOptions,
): AsyncGenerator<CheckpointTuple>
Retrieve a list of checkpoint tuples from the MongoDB database based on the provided config. The checkpoints are ordered by checkpoint ID in descending order (newest first).
Parameters
- config: RunnableConfig
- Optionaloptions: CheckpointListOptions
Returns AsyncGenerator<CheckpointTuple>
Overrides BaseCheckpointSaver.list
- Defined in checkpoint-mongodb/src/index.ts:134

put

put(
    config: RunnableConfig,
    checkpoint: Checkpoint,
    metadata: CheckpointMetadata,
): Promise<RunnableConfig<Record<string, any>>>
Saves a checkpoint to the MongoDB database. The checkpoint is associated with the provided config and its parent config (if any).
Parameters
- config: RunnableConfig
- checkpoint: Checkpoint
- metadata: CheckpointMetadata
Returns Promise<RunnableConfig<Record<string, any>>>
Overrides BaseCheckpointSaver.put
- Defined in checkpoint-mongodb/src/index.ts:208

putWrites

putWrites(
    config: RunnableConfig,
    writes: PendingWrite[],
    taskId: string,
): Promise<void>
Saves intermediate writes associated with a checkpoint to the MongoDB database.
Parameters
- config: RunnableConfig
- writes: PendingWrite[]
- taskId: string
Returns Promise<void>
Overrides BaseCheckpointSaver.putWrites
- Defined in checkpoint-mongodb/src/index.ts:259