Class BaseCheckpointSaver<V>Abstract

constructor

• new BaseCheckpointSaver<V extends string | number = number>(
      serde?: SerializerProtocol,
  ): BaseCheckpointSaver<V>

  Type Parameters

  • V extends string | number = number

  Parameters

  • Optionalserde: SerializerProtocol

  Returns BaseCheckpointSaver<V>

serde

get

• get(config: RunnableConfig): Promise<undefined | Checkpoint<string, string>>

  Parameters

  • config: RunnableConfig

  Returns Promise<undefined | Checkpoint<string, string>>

getNextVersion

• getNextVersion(current: undefined | V, _channel: ChannelProtocol): V

  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 | V
  • _channel: ChannelProtocol

  Returns V

AbstractgetTuple

• getTuple(config: RunnableConfig): Promise<undefined | CheckpointTuple>

  Parameters

  • config: RunnableConfig

  Returns Promise<undefined | CheckpointTuple>

Abstractlist

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

  Parameters

  • config: RunnableConfig
  • Optionaloptions: CheckpointListOptions

  Returns AsyncGenerator<CheckpointTuple>

Abstractput

• put(
      config: RunnableConfig,
      checkpoint: Checkpoint,
      metadata: CheckpointMetadata,
      newVersions: ChannelVersions,
  ): Promise<RunnableConfig<Record<string, any>>>

  Parameters

  • config: RunnableConfig
  • checkpoint: Checkpoint
  • metadata: CheckpointMetadata
  • newVersions: ChannelVersions

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

AbstractputWrites

• putWrites(
      config: RunnableConfig,
      writes: PendingWrite<string>[],
      taskId: string,
  ): Promise<void>

  Store intermediate writes linked to a checkpoint.

  Parameters

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

  Returns Promise<void>