Class BaseStoreAbstract

Execute multiple operations in a single batch. This is more efficient than executing operations individually.

Delete an item from the store.

Retrieve a single item by its namespace and key.

List and filter namespaces in the store. Used to explore data organization and navigate the namespace hierarchy.

Example

// List all namespaces under "documents"
await store.listNamespaces({
  prefix: ["documents"],
  maxDepth: 2
});

// List namespaces ending with "v1"
await store.listNamespaces({
  suffix: ["v1"],
  limit: 50
});
Copy

Store or update an item.

Example

// Simple storage
await store.put(["docs"], "report", { title: "Annual Report" });

// With specific field indexing
await store.put(
  ["docs"],
  "report",
  {
    title: "Q4 Report",
    chapters: [{ content: "..." }, { content: "..." }]
  },
  ["title", "chapters[*].content"]
);
Copy

Search for items within a namespace prefix. Supports both metadata filtering and vector similarity search.

Example

// Search with filters
await store.search(["documents"], {
  filter: { type: "report", status: "active" },
  limit: 5,
  offset: 10
});

// Vector similarity search
await store.search(["users", "content"], {
  query: "technical documentation about APIs",
  limit: 20
});
Copy

Start the store. Override if initialization is needed.

Stop the store. Override if cleanup is needed.