Skip to main content

KurrentDB checkpoint implementation for LangGraph

Project description

LangGraph Checkpoint KurrentDB: Experimental

KurrentDB checkpoint implementation for LangGraph. This is an experimental release and not be ready to be used in production, yet. This project is intended to show that KurrentDB has the right native capabilities to be used as a checkpointing mechanism for LangGraph.

If you would like to see a production version of the checkpointer, feel free to upvote this issue: https://github.com/kurrent-io/langgraph-checkpoint-kurrentdb/issues/3

Overview

LangGraph is an orchestration framework for complex agentic systems. This package provides a checkpointing mechanism for LangGraph using KurrentDB. We use KurrentDB's event sourcing capabilities to store the state of the LangGraph execution. The versioning of state is mapped to KurrentDB's native event versioning and every the channel value is kept into its own stream. Every step in the thread then only has a pointer (channel value name and version) to the actual channel value (event). (Original Langgraph's channel versioning is also kept)

graph TD
  subgraph ThreadStream["Thread's Stream"]
    Step1["Step -1 (event)"]
    Step2["Step 0 (event)"]
    Step3["Step 1... (event)"]
  end

  subgraph ChannelValueStreams["Channel Value Streams"]
    ChannelA["Channel A"]
    ChannelB["Channel B"]
    ChannelC["Channel C"]
  end

  subgraph ChannelValueEvents["Channel A Value Events"]
    Event0["Event V0"]
    Event1["Event V1"]
    Event2["Event V2..."]
  end

  Step1 -->|Points to| ChannelA
  Step1 -->|Points to| ChannelB
  Step2 -->|Points to| ChannelB
  Step2 -->|Points to| ChannelC
  Step3 -->|Points to| ChannelA
  Step3 -->|Points to| ChannelC
  ChannelA -->|Points to| ChannelValueEvents

Installation

pip install langgraph-checkpoint-kurrentdb

Or using Poetry:

poetry add langgraph-checkpoint-kurrentdb

Usage

Setting up the KurrentDB checkpointer for your LangGraph:

from langgraph.graph import StateGraph
from langgraph_checkpoint_kurrentdb import KurrentDBSaver
from kurrentdbclient import KurrentDBClient

# Initialize the KurrentDB client
client = KurrentDBClient(uri="esdb://localhost:2113?Tls=false")

# Create the KurrentDB checkpoint saver
saver = KurrentDBSaver(client)

# Create your LangGraph
builder = StateGraph(int)
builder.add_node("add_one", lambda x: x + 1)
builder.set_entry_point("add_one")
builder.set_finish_point("add_one")

# Compile with the KurrentDB checkpointer
graph = builder.compile(checkpointer=saver)

# Use thread ID to identify this execution
config = {"configurable": {"thread_id": "example-thread-1", "checkpoint_ns": ""}}
result = graph.invoke(42, config)

# Later, retrieve the state
state = graph.get_state(config)

Tests

poetry run pytest --cov --cov-report=term-missing

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

langgraph_checkpoint_kurrentdb-0.1.1.tar.gz (8.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file langgraph_checkpoint_kurrentdb-0.1.1.tar.gz.

File metadata

File hashes

Hashes for langgraph_checkpoint_kurrentdb-0.1.1.tar.gz
Algorithm Hash digest
SHA256 358215c081b5b4294c338a835c254732d95c14a8981f8af1ac317f51a69365c0
MD5 ecf1af8bc7157cfa2e5b261ac208cbc4
BLAKE2b-256 7e8d1dd0d8d72cda8bdc0e2ec2d582ad911f03078e57d150f146a8812eeab06e

See more details on using hashes here.

File details

Details for the file langgraph_checkpoint_kurrentdb-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for langgraph_checkpoint_kurrentdb-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b60664f057367dd6908c2b537a36cf26bad0e035d8c2900d85fc34362037c646
MD5 516b179d598d71949cdeec79b8967570
BLAKE2b-256 c5fe7deea9c08df8f61857471a5a95478a7d6687ef6245f7b9df4bffd9968c9d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page