Skip to main content

Get Store

The GetStore request retrieves detailed information about a single store by its name.

  • Input: Store name.

  • Behavior: The server returns detailed information about the specified store.

  • Response: Store information including name, dimension, indices, and size.

Click to expand source code
import { createDbClient } from "ahnlich-client-node";
import { GetStore } from "ahnlich-client-node/grpc/db/query_pb";

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

const response = await client.getStore(
new GetStore({ store: "my_store" })
);

console.log(response.name); // Store name
console.log(response.dimension); // Vector dimension
console.log(response.predicateIndices); // Indexed predicate keys
console.log(response.nonLinearIndices); // Non-linear algorithm indices
console.log(response.len); // Number of entries
console.log(response.sizeInBytes); // Size on disk
}

getStore();

Parameters​

ParameterTypeRequiredDescription
storestringYesThe name of the store to retrieve

Response Fields​

FieldTypeDescription
namestringThe name of the store
dimensionnumberVector dimension for this store
lennumberNumber of entries in the store
sizeInBytesbigintTotal size of the store in bytes
predicateIndicesstring[]List of indexed predicate keys
nonLinearIndicesNonLinearAlgorithm[]List of non-linear indices