AzureCosmosNoSqlKVStore

Defined in: providers/storage/azure/src/kvStore/AzureCosmosNoSqlKVStore.ts:63

Extends

• BaseKVStore

Constructors

new AzureCosmosNoSqlKVStore()

new AzureCosmosNoSqlKVStore(__namedParameters): AzureCosmosNoSqlKVStore

Defined in: providers/storage/azure/src/kvStore/AzureCosmosNoSqlKVStore.ts:75

Parameters

__namedParameters

AzureCosmosNoSqlKVStoreConfig

Returns

AzureCosmosNoSqlKVStore

Overrides

BaseKVStore.constructor

Methods

client()

client(): CosmosClient

Defined in: providers/storage/azure/src/kvStore/AzureCosmosNoSqlKVStore.ts:107

Returns

CosmosClient

---

fromConnectionString()

static fromConnectionString(config): AzureCosmosNoSqlKVStore

Defined in: providers/storage/azure/src/kvStore/AzureCosmosNoSqlKVStore.ts:143

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

---

fromAccountAndKey()

static fromAccountAndKey(config): AzureCosmosNoSqlKVStore

Defined in: providers/storage/azure/src/kvStore/AzureCosmosNoSqlKVStore.ts:169

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

---

fromAadToken()

static fromAadToken(config): AzureCosmosNoSqlKVStore

Defined in: providers/storage/azure/src/kvStore/AzureCosmosNoSqlKVStore.ts:202

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

---

put()

put(key, val): Promise<void>

Defined in: providers/storage/azure/src/kvStore/AzureCosmosNoSqlKVStore.ts:227

Parameters

key

string

val

Record<string, any>

Returns

Promise<void>

Overrides

BaseKVStore.put

---

get()

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

Defined in: providers/storage/azure/src/kvStore/AzureCosmosNoSqlKVStore.ts:235

Parameters

key

string

Returns

Promise<null | Record<string, any>>

Overrides

BaseKVStore.get

---

getAll()

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

Defined in: providers/storage/azure/src/kvStore/AzureCosmosNoSqlKVStore.ts:246

Returns

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

Overrides

BaseKVStore.getAll

---

delete()

delete(key): Promise<boolean>

Defined in: providers/storage/azure/src/kvStore/AzureCosmosNoSqlKVStore.ts:264

Parameters

key

string

Returns

Promise<boolean>

Overrides

BaseKVStore.delete