LangChain Reference home pageLangChain ReferenceLangChain Reference
  • GitHub
  • Main Docs
Deep Agents
LangChain
LangGraph
Integrations
LangSmith
  • Overview
  • LangGraph Checkpoint
    Checkpoint Postgres
    Store Postgres
    Checkpoint SQLite
    LangGraph Prebuilt
    LangGraph CLI
    LangGraph SDK
    LangGraph Supervisor
    LangGraph Swarm
    ⌘I

    LangChain Assistant

    Ask a question to get started

    Enter to send•Shift+Enter new line

    Menu

    LangGraph Checkpoint
    Checkpoint Postgres
    Store Postgres
    Checkpoint SQLite
    LangGraph Prebuilt
    LangGraph CLI
    LangGraph SDK
    LangGraph Supervisor
    LangGraph Swarm
    Language
    Theme
    Pythonlanggraph.checkpointbaseCheckpointMetadata
    Class●Since v1.0

    CheckpointMetadata

    Metadata associated with a checkpoint.

    Copy
    CheckpointMetadata()

    Bases

    TypedDict

    Constructors

    constructor
    __init__
    NameType
    sourceLiteral['input', 'loop', 'update', 'fork']
    stepint
    parentsdict[str, str]
    run_idstr
    delta_updates_since_snapshotdict[str, int]

    Attributes

    attribute
    source: Literal['input', 'loop', 'update', 'fork']

    The source of the checkpoint.

    • "input": The checkpoint was created from an input to invoke/stream/batch.
    • "loop": The checkpoint was created from inside the pregel loop.
    • "update": The checkpoint was created from a manual state update.
    • "fork": The checkpoint was created as a copy of another checkpoint.
    attribute
    step: int

    The step number of the checkpoint.

    -1 for the first "input" checkpoint. 0 for the first "loop" checkpoint. ... for the nth checkpoint afterwards.

    attribute
    parents: dict[str, str]

    The IDs of the parent checkpoints.

    Mapping from checkpoint namespace to checkpoint ID.

    attribute
    run_id: str

    The ID of the run that created this checkpoint.

    attribute
    delta_updates_since_snapshot: dict[str, int]

    Per-channel update count since the last _DeltaSnapshot was written.

    Maps channel name → number of supersteps that wrote to this channel since its last snapshot blob. Used by pregel.create_checkpoint to decide when to write the next snapshot (when the count reaches the channel's snapshot_frequency, snapshot fires and the count resets to 0). Absent on threads that don't use delta channels. Version-format independent — works for int, float, and string version schemes.

    View source on GitHub