Class MongoDBSaver

constructor

• new MongoDBSaver(__namedParameters, serde?): MongoDBSaver

• Parameters

  • __namedParameters: MongoDBSaverParams
  • Optional serde: SerializerProtocol

  Returns MongoDBSaver

checkpointCollectionName

checkpointWritesCollectionName

deleteThread

• deleteThread(threadId): 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>

getTuple

• getTuple(config): 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<Record<string, any>>

  Returns Promise<undefined | CheckpointTuple>

list

• list(config, options?): AsyncGenerator<CheckpointTuple, any, any>

• 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<Record<string, any>>
  • Optional options: CheckpointListOptions

  Returns AsyncGenerator<CheckpointTuple, any, any>

put

• put(config, checkpoint, metadata): 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<Record<string, any>>
  • checkpoint: Checkpoint<string, string>
  • metadata: CheckpointMetadata

  Returns Promise<RunnableConfig<Record<string, any>>>

putWrites

• putWrites(config, writes, taskId): Promise<void>

• Saves intermediate writes associated with a checkpoint to the MongoDB database.

  Parameters

  • config: RunnableConfig<Record<string, any>>
  • writes: PendingWrite[]
  • taskId: string

  Returns Promise<void>