List Stores

Schema

ListStores accepts an optional schema field. When it is omitted, the server lists stores in public only; it does not list stores across every schema. Set schema to list stores in another schema.

The ListStores request retrieves vector stores from one schema on the Ahnlich DB server. When schema is omitted, that schema is public.

• Input: Optional schema field.

• Behavior: The server returns stores in the requested schema, including their names, dimensions, and indices.

• Response: A list of StoreInfo objects containing store metadata.

Click to expand source code

TypeScript

import { createDbClient } from "ahnlich-client-node";
import { ListStores } from "ahnlich-client-node/grpc/db/query_pb";

async function listStores() {
  const client = createDbClient("127.0.0.1:1369");

  const response = await client.listStores(new ListStores({ schema: "analytics" }));

  // Get store names
  console.log(response.stores.map((s) => s.name));

  // Iterate over stores with full details
  for (const store of response.stores) {
    console.log(`Store: ${store.name}`);
    console.log(`  Dimension: ${store.dimension}`);
    console.log(`  Entries: ${store.len}`);
    console.log(`  Size: ${store.sizeInBytes} bytes`);
    console.log(`  Predicate Indices: ${store.predicateIndices}`);
    console.log(`  Non-Linear Indices: ${store.nonLinearIndices}`);
  }
}

listStores();

StoreInfo Fields

Each StoreInfo object contains:

Field	Type	Description
name	string	The name of the store
dimension	number	Vector dimension for this store
len	number	Number of entries in the store
sizeInBytes	bigint	Total size of the store in bytes
predicateIndices	string[]	List of indexed predicate keys
nonLinearIndices	NonLinearAlgorithm[]	List of non-linear indices (HNSW)