LangChain Reference home pageLangChain ReferenceLangChain Reference
  • GitHub
  • Main Docs
Deep Agents
LangChain
LangGraph
Integrations
LangSmith
  • Overview
  • LangGraph Checkpoint
    LangGraph Store
    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
    LangGraph Store
    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

    Copy
    CheckpointMetadata()

    Bases

    TypedDict

    Constructors

    Attributes

    View source on GitHub
    constructor
    __init__
    NameType
    sourceLiteral['input', 'loop', 'update', 'fork']
    stepint
    parentsdict[str, str]
    run_idstr
    counters_since_delta_snapshotdict[str, tuple[int, int]]
    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
    counters_since_delta_snapshot: dict[str, tuple[int, int]]

    Per-channel counters since the last _DeltaSnapshot was written.

    Beta

    This metadata field backs DeltaChannel (beta). The key name and contents may change while the delta-channel design stabilizes.

    Maps channel name -> (updates, supersteps):

    • index 0 (updates): number of supersteps that wrote to this channel since its last snapshot blob.
    • index 1 (supersteps): total supersteps elapsed since this channel's last snapshot, regardless of whether the channel was written.

    A snapshot fires when EITHER updates >= ch.snapshot_frequency OR supersteps >= DELTA_MAX_SUPERSTEPS_SINCE_SNAPSHOT (system-wide bound, default 5000, env LANGGRAPH_DELTA_MAX_SUPERSTEPS_SINCE_SNAPSHOT). The supersteps bound prevents unbounded ancestor walks on threads where a delta channel exists but is no longer being updated.

    Absent on threads that don't use delta channels. Persisted as a 2-element list in JSON (no native tuple).

    Metadata associated with a checkpoint.