Class RedisSaver

A Redis implementation of the BaseCheckpointSaver for LangGraph.

This saver stores checkpoint data in Redis, providing durable persistence across application restarts. It supports both the node-redis and ioredis clients.

Example

import { RedisSaver } from "langgraph-db/providers/redis";

// Create a Redis-backed checkpoint saver
const saver = new RedisSaver({
  url: "redis://localhost:6379",
  ttl: 3600 // 1 hour TTL (optional)
});

// Use with a LangGraph
const graph = new StateGraph({
  channels: { input: { value: "" } },
  nodes: {}, // define your nodes here
  checkpointer: saver
});
Copy

Example

// Using with IORedis
import { RedisSaver } from "langgraph-db/providers/redis";
import IORedis from "ioredis";

// Create an IORedis client
const ioredisClient = new IORedis("redis://localhost:6379");

// Create a Redis-backed checkpoint saver with IORedis
const saver = new RedisSaver({
  client: ioredisClient,
  ttl: 3600 // 1 hour TTL (optional)
});
Copy

Example

// Retrieving checkpoints
import { RedisSaver } from "langgraph-db/providers/redis";

const saver = new RedisSaver();
await saver.connect();

// Get a specific checkpoint by ID
const checkpoint = await saver.getTuple({
  configurable: {
    thread_id: "user_123",
    checkpoint_id: "abc123",
    checkpoint_ns: "conversation"
  }
});

// Or get the most recent checkpoint for a thread
const latestCheckpoint = await saver.getTuple({
  configurable: {
    thread_id: "user_123",
    checkpoint_ns: "conversation"
  }
});
Copy

Example

// Listing checkpoints with filtering
import { RedisSaver } from "langgraph-db/providers/redis";

const saver = new RedisSaver();

// List all checkpoints for a thread with filtering
const checkpoints = [];
for await (const checkpoint of saver.list({
  configurable: { thread_id: "user_123" }
}, {
  filter: { status: "completed" },  // Filter by metadata
  limit: 10  // Limit to 10 results
})) {
  checkpoints.push(checkpoint);
}
Copy

Example

// Manual cleanup when done
import { RedisSaver } from "langgraph-db/providers/redis";

const saver = new RedisSaver();

try {
  // Use the saver...
} finally {
  // Properly disconnect when done
  await saver.disconnect();
}
Copy