Edit

Share via

CosmosDbPartitionedStorageOptions interface

Package:
botbuilder-azure

Cosmos DB Partitioned Storage Options.

Properties

authKey

The authentication key for Cosmos DB.
compatibilityMode

Early version of CosmosDb had a max key length of 255. Keys longer than this were truncated in cosmosDbKeyEscape.escapeKey. This remains the default behavior of cosmosDbPartitionedStorage, but can be overridden by setting compatibilityMode to false. compatibilityMode cannot be true if keySuffix is used.
containerId

The container identifier.
containerThroughput

The throughput set when creating the Container. Defaults to 400.
cosmosClientOptions

The options for the CosmosClient.
cosmosDbEndpoint

The CosmosDB endpoint.
databaseId

The database identifier for Cosmos DB instance.
keySuffix

The suffix to be added to every key. See cosmosDbKeyEscape.escapeKey Note: compatibilityMode must be set to 'false' to use a KeySuffix. When KeySuffix is used, keys will NOT be truncated but an exception will be thrown if the key length is longer than allowed by CosmosDb.

The keySuffix must contain only valid CosmosDb key characters. (e.g. not: '\', '?', '/', '#', '*')

Property Details

authKey

The authentication key for Cosmos DB.

authKey?: string

Property Value

string

compatibilityMode

Early version of CosmosDb had a max key length of 255. Keys longer than this were truncated in cosmosDbKeyEscape.escapeKey. This remains the default behavior of cosmosDbPartitionedStorage, but can be overridden by setting compatibilityMode to false. compatibilityMode cannot be true if keySuffix is used.

compatibilityMode?: boolean

Property Value

boolean

containerId

The container identifier.

containerId: string

Property Value

string

containerThroughput

The throughput set when creating the Container. Defaults to 400.

containerThroughput?: number

Property Value

number

cosmosClientOptions

The options for the CosmosClient.

cosmosClientOptions?: CosmosClientOptions

Property Value

CosmosClientOptions

cosmosDbEndpoint

The CosmosDB endpoint.

cosmosDbEndpoint?: string

Property Value

string

databaseId

The database identifier for Cosmos DB instance.

databaseId: string

Property Value

string

keySuffix

The suffix to be added to every key. See cosmosDbKeyEscape.escapeKey Note: compatibilityMode must be set to 'false' to use a KeySuffix. When KeySuffix is used, keys will NOT be truncated but an exception will be thrown if the key length is longer than allowed by CosmosDb.

The keySuffix must contain only valid CosmosDb key characters. (e.g. not: '\', '?', '/', '#', '*')

keySuffix?: string

Property Value

string