Class MongoDBSaver

constructor

• new MongoDBSaver(
      __namedParameters: MongoDBSaverParams,
      serde?: any,
  ): MongoDBSaver

  Parameters

  • __namedParameters: MongoDBSaverParams
  • Optionalserde: any

  Returns MongoDBSaver

checkpointCollectionName

checkpointWritesCollectionName

deleteThread

• deleteThread(threadId: string): Promise<void>

  Parameters

  • threadId: string

  Returns Promise<void>

getTuple

• getTuple(config: RunnableConfig): Promise<any>

  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<any>

list

• list(config: RunnableConfig, options?: any): 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: any

  Returns AsyncGenerator<CheckpointTuple>

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>>>

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>