LangChain Reference home pageLangChain ReferenceLangChain Reference
  • GitHub
  • Main Docs
Deep Agents
LangChain
LangGraph
Integrations
LangSmith
LangGraph
  • Web
  • Channels
  • Pregel
  • Prebuilt
  • Remote
  • Stream
LangGraph SDK
  • Ui
  • Client
  • Auth
  • React
  • Logging
  • React Ui
  • Utils
  • Server
  • Stream
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
WebChannelsPregelPrebuiltRemoteStream
LangGraph SDK
UiClientAuthReactLoggingReact UiUtilsServerStream
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-checkpointindexPutOperation
Interfaceā—Since v0.0

PutOperation

Copy
interface PutOperation

Properties

View source on GitHub
property
index: false | string[]
property
key: string
property
namespace: string[]
property
value: Record<string, any> | null

Operation to store, update, or delete an item.

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"

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

Hierarchical path for the item.

The stored data as an object. Keys are filterable.

Copy
// Index specific fields
index: ["metadata.title", "chapters[*].content"]

// Disable indexing
index: false
Copy
key: "user123"  // For a user profile
key: "doc456"   // For a document
Copy
// Get a user profile
namespace: ["users", "profiles"]