LangChain Reference home pageLangChain ReferenceLangChain Reference
  • GitHub
  • Main Docs
Deep Agents
LangChain
LangGraph
Integrations
LangSmith
LangGraph
  • Web
  • Channels
  • Pregel
  • Prebuilt
  • Remote
LangGraph SDK
  • Client
  • Auth
  • React
  • Logging
  • React Ui
  • Server
LangGraph Checkpoint
LangGraph Checkpoint MongoDB
LangGraph Checkpoint Postgres
  • Store
LangGraph Checkpoint Redis
  • Shallow
  • Store
LangGraph Checkpoint SQLite
LangGraph Checkpoint Validation
  • Cli
LangGraph API
LangGraph CLI
LangGraph CUA
  • Utils
LangGraph Supervisor
LangGraph Swarm
⌘I

LangChain Assistant

Ask a question to get started

Enter to send•Shift+Enter new line

Menu

LangGraph
WebChannelsPregelPrebuiltRemote
LangGraph SDK
ClientAuthReactLoggingReact UiServer
LangGraph Checkpoint
LangGraph Checkpoint MongoDB
LangGraph Checkpoint Postgres
Store
LangGraph Checkpoint Redis
ShallowStore
LangGraph Checkpoint SQLite
LangGraph Checkpoint Validation
Cli
LangGraph API
LangGraph CLI
LangGraph CUA
Utils
LangGraph Supervisor
LangGraph Swarm
Language
Theme
JavaScript@langchain/langgraph-checkpointPutOperation
Interface●Since v0.0

PutOperation

Operation to store, update, or delete an item.

Copy
interface PutOperation

Properties

property
index: false | string[]

Controls how the item's fields are indexed for search operations.

  • undefined: Uses store's default indexing configuration
  • false: Disables indexing for this item
  • string[]: List of field paths to index

Path syntax supports:

  • Nested fields: "metadata.title"
  • Array access: "chapters[*].content" (each indexed separately)
  • Specific indices: "authors[0].name"
Copy
// Index specific fields
index: ["metadata.title", "chapters[*].content"]

// Disable indexing
index: false
property
key: string

Unique identifier for the document within its namespace. Together with namespace forms the complete path to the item.

Example: If namespace is ["documents", "user123"] and key is "report1", the full path would effectively be "documents/user123/report1"

property
namespace: string[]

Hierarchical path for the item. Acts as a folder-like structure to organize items. Each element represents one level in the hierarchy.

Copy
// Root level documents
namespace: ["documents"]

// User-specific documents
namespace: ["documents", "user123"]

// Nested cache structure
namespace: ["cache", "docs", "v1"]
property
value: Record<string, any> | null

Data to be stored, or null to delete the item. Must be a JSON-serializable object with string keys. Setting to null signals that the item should be deleted.

Copy
{
   *   field1: "string value",
   *   field2: 123,
   *   nested: { can: "contain", any: "serializable data" }
   * }
View source on GitHub