AzureCosmosNoSqlKVStore
Defined in: .build/typescript/packages/providers/storage/azure/src/kvStore/AzureCosmosNoSqlKVStore.ts:63
Extends
Section titled “Extends”BaseKVStore
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new AzureCosmosNoSqlKVStore(
__namedParameters):AzureCosmosNoSqlKVStore
Defined in: .build/typescript/packages/providers/storage/azure/src/kvStore/AzureCosmosNoSqlKVStore.ts:75
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”Returns
Section titled “Returns”AzureCosmosNoSqlKVStore
Overrides
Section titled “Overrides”BaseKVStore.constructor
Methods
Section titled “Methods”client()
Section titled “client()”client():
CosmosClient
Defined in: .build/typescript/packages/providers/storage/azure/src/kvStore/AzureCosmosNoSqlKVStore.ts:107
Returns
Section titled “Returns”CosmosClient
fromConnectionString()
Section titled “fromConnectionString()”
staticfromConnectionString(config):AzureCosmosNoSqlKVStore
Defined in: .build/typescript/packages/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
Section titled “Parameters”config
Section titled “config”object & AzureCosmosNoSqlKVStoreConfig = {}
Returns
Section titled “Returns”AzureCosmosNoSqlKVStore
Instance of AzureCosmosNoSqlKVStore
fromAccountAndKey()
Section titled “fromAccountAndKey()”
staticfromAccountAndKey(config):AzureCosmosNoSqlKVStore
Defined in: .build/typescript/packages/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
Section titled “Parameters”config
Section titled “config”object & AzureCosmosNoSqlKVStoreConfig = {}
Returns
Section titled “Returns”AzureCosmosNoSqlKVStore
Instance of AzureCosmosNoSqlKVStore
fromAadToken()
Section titled “fromAadToken()”
staticfromAadToken(config):AzureCosmosNoSqlKVStore
Defined in: .build/typescript/packages/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
Section titled “Parameters”config
Section titled “config”object & AzureCosmosNoSqlKVStoreConfig = {}
Returns
Section titled “Returns”AzureCosmosNoSqlKVStore
Instance of AzureCosmosNoSqlKVStore
put(
key,val):Promise<void>
Defined in: .build/typescript/packages/providers/storage/azure/src/kvStore/AzureCosmosNoSqlKVStore.ts:227
Parameters
Section titled “Parameters”string
Record<string, any>
Returns
Section titled “Returns”Promise<void>
Overrides
Section titled “Overrides”BaseKVStore.put
get(
key):Promise<null|Record<string,any>>
Defined in: .build/typescript/packages/providers/storage/azure/src/kvStore/AzureCosmosNoSqlKVStore.ts:235
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<null | Record<string, any>>
Overrides
Section titled “Overrides”BaseKVStore.get
getAll()
Section titled “getAll()”getAll():
Promise<Record<string,Record<string,any>>>
Defined in: .build/typescript/packages/providers/storage/azure/src/kvStore/AzureCosmosNoSqlKVStore.ts:246
Returns
Section titled “Returns”Promise<Record<string, Record<string, any>>>
Overrides
Section titled “Overrides”BaseKVStore.getAll
delete()
Section titled “delete()”delete(
key):Promise<boolean>
Defined in: .build/typescript/packages/providers/storage/azure/src/kvStore/AzureCosmosNoSqlKVStore.ts:264
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<boolean>
Overrides
Section titled “Overrides”BaseKVStore.delete