Class: AzureCosmosNoSqlKVStore

Extends

• BaseKVStore

Constructors

new AzureCosmosNoSqlKVStore()

new AzureCosmosNoSqlKVStore(__namedParameters): AzureCosmosNoSqlKVStore

Parameters

• __namedParameters: AzureCosmosNoSqlKVStoreConfig

Returns

AzureCosmosNoSqlKVStore

Overrides

BaseKVStore.constructor

Defined in

packages/llamaindex/src/storage/kvStore/AzureCosmosNoSqlKVStore.ts:75

Methods

client()

client(): CosmosClient

Returns

CosmosClient

Defined in

packages/llamaindex/src/storage/kvStore/AzureCosmosNoSqlKVStore.ts:107

---

delete()

delete(key): Promise<boolean>

Parameters

• key: string

Returns

Promise<boolean>

Overrides

BaseKVStore.delete

Defined in

packages/llamaindex/src/storage/kvStore/AzureCosmosNoSqlKVStore.ts:264

---

get()

get(key): Promise<null | Record<string, any>>

Parameters

• key: string

Returns

Promise<null | Record<string, any>>

Overrides

BaseKVStore.get

Defined in

packages/llamaindex/src/storage/kvStore/AzureCosmosNoSqlKVStore.ts:235

---

getAll()

getAll(): Promise<Record<string, Record<string, any>>>

Returns

Promise<Record<string, Record<string, any>>>

Overrides

BaseKVStore.getAll

Defined in

packages/llamaindex/src/storage/kvStore/AzureCosmosNoSqlKVStore.ts:246

---

put()

put(key, val): Promise<void>

Parameters

• key: string

• val: Record<string, any>

Returns

Promise<void>

Overrides

BaseKVStore.put

Defined in

packages/llamaindex/src/storage/kvStore/AzureCosmosNoSqlKVStore.ts:227

---

fromAadToken()

static fromAadToken(config): AzureCosmosNoSqlKVStore

Static method for creating an instance using AAD token. If no endpoint and credentials are provided, it will attempt to use the env variable AZURE_COSMOSDB_NOSQL_ACCOUNT_ENDPOINT as endpoint and use DefaultAzureCredential() as credentials.

Parameters

• config: object & AzureCosmosNoSqlKVStoreConfig = {}

Returns

AzureCosmosNoSqlKVStore

Instance of AzureCosmosNoSqlKVStore

Defined in

packages/llamaindex/src/storage/kvStore/AzureCosmosNoSqlKVStore.ts:202

---

fromAccountAndKey()

static fromAccountAndKey(config): AzureCosmosNoSqlKVStore

Static method for creating an instance using a account endpoint and key. If no endpoint and key is provided, it will attempt to use the env variable AZURE_COSMOSDB_NOSQL_ACCOUNT_ENDPOINT as enpoint and AZURE_COSMOSDB_NOSQL_ACCOUNT_KEY as key.

Parameters

• config: object & AzureCosmosNoSqlKVStoreConfig = {}

Returns

AzureCosmosNoSqlKVStore

Instance of AzureCosmosNoSqlKVStore

Defined in

packages/llamaindex/src/storage/kvStore/AzureCosmosNoSqlKVStore.ts:169

---

fromConnectionString()

static fromConnectionString(config): AzureCosmosNoSqlKVStore

Static method for creating an instance using a connection string. If no connection string is provided, it will attempt to use the env variable AZURE_COSMOSDB_NOSQL_CONNECTION_STRING as connection string.

Parameters

• config: object & AzureCosmosNoSqlKVStoreConfig = {}

Returns

AzureCosmosNoSqlKVStore

Instance of AzureCosmosNoSqlKVStore

Defined in

packages/llamaindex/src/storage/kvStore/AzureCosmosNoSqlKVStore.ts:143