kvStore

@codebolt/codeboltjs

---

Variable: kvStore

const kvStore: {
  createInstance: (name: string, description?: string) => Promise<KVInstanceResponse>;
  delete: (instanceId: string, namespace: string, key: string) => Promise<KVDeleteResponse>;
  deleteInstance: (instanceId: string) => Promise<KVDeleteResponse>;
  deleteNamespace: (instanceId: string, namespace: string) => Promise<KVDeleteNamespaceResponse>;
  get: (instanceId: string, namespace: string, key: string) => Promise<KVGetResponse>;
  getInstance: (instanceId: string) => Promise<KVInstanceResponse>;
  getNamespaces: (instanceId: string) => Promise<KVNamespacesResponse>;
  getRecordCount: (instanceId: string, namespace?: string) => Promise<KVRecordCountResponse>;
  listInstances: () => Promise<KVInstanceListResponse>;
  query: (query: KVQueryDSL) => Promise<KVQueryResponse>;
  set: (instanceId: string, namespace: string, key: string, value: any, autoCreateInstance: boolean) => Promise<KVSetResponse>;
  updateInstance: (instanceId: string, updates: UpdateKVInstanceParams) => Promise<KVInstanceResponse>;
};

Defined in: packages/codeboltjs/src/modules/kvStore.ts:24

Type Declaration

Name	Type	Description	Defined in
createInstance()	(name: string, description?: string) => Promise<KVInstanceResponse>	Create a new KV store instance	packages/codeboltjs/src/modules/kvStore.ts:30
delete()	(instanceId: string, namespace: string, key: string) => Promise<KVDeleteResponse>	Delete a value from the KV store	packages/codeboltjs/src/modules/kvStore.ts:149
deleteInstance()	(instanceId: string) => Promise<KVDeleteResponse>	Delete a KV store instance	packages/codeboltjs/src/modules/kvStore.ts:90
deleteNamespace()	(instanceId: string, namespace: string) => Promise<KVDeleteNamespaceResponse>	Delete an entire namespace from the KV store	packages/codeboltjs/src/modules/kvStore.ts:165
get()	(instanceId: string, namespace: string, key: string) => Promise<KVGetResponse>	Get a value from the KV store	packages/codeboltjs/src/modules/kvStore.ts:107
getInstance()	(instanceId: string) => Promise<KVInstanceResponse>	Get a KV store instance by ID	packages/codeboltjs/src/modules/kvStore.ts:45
getNamespaces()	(instanceId: string) => Promise<KVNamespacesResponse>	Get all namespaces in an instance	packages/codeboltjs/src/modules/kvStore.ts:195
getRecordCount()	(instanceId: string, namespace?: string) => Promise<KVRecordCountResponse>	Get record count for an instance or namespace	packages/codeboltjs/src/modules/kvStore.ts:211
listInstances()	() => Promise<KVInstanceListResponse>	List all KV store instances	packages/codeboltjs/src/modules/kvStore.ts:59
query()	(query: KVQueryDSL) => Promise<KVQueryResponse>	Query the KV store using DSL	packages/codeboltjs/src/modules/kvStore.ts:180
set()	(instanceId: string, namespace: string, key: string, value: any, autoCreateInstance: boolean) => Promise<KVSetResponse>	Set a value in the KV store	packages/codeboltjs/src/modules/kvStore.ts:126
updateInstance()	(instanceId: string, updates: UpdateKVInstanceParams) => Promise<KVInstanceResponse>	Update a KV store instance	packages/codeboltjs/src/modules/kvStore.ts:75