Miscellaneous
This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.
Property | Description |
BatchSize | The maximum size of each batch operation to submit. |
CalculateAggregates | Specifies whether will return the calculated value of the aggregates or grouped by partiton range. |
ConnectionLifeTime | The maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed. |
ConsistencyLevel | Denotes the type of token: master or resource. |
FlattenArrays | By default, nested arrays are returned as strings of JSON. The FlattenArrays property can be used to flatten the elements of nested arrays into columns of their own. Set FlattenArrays to the number of elements you want to return from nested arrays. |
FlattenObjects | Set FlattenObjects to true to flatten object properties into columns of their own. Otherwise, objects nested in arrays are returned as strings of JSON. |
ForceQueryOnNonIndexedContainers | Force the use of an index scan to process the query if indexing is disabled or the right index path is not available. |
GenerateSchemaFiles | Indicates the user preference as to when schemas should be generated and saved. |
MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
MaxThreads | Specifies the maximum number of concurrent requests for Batch CUD (Create, Update, Delete) operations. |
MultiThreadCount | Aggregate queries in partitioned collections will require parallel requests for different partition ranges. Set this to the number of parallel request to be issued in the same time. |
Other | These hidden properties are used only in specific use cases. |
Pagesize | The maximum number of results to return per page from Azure Cosmos DB. |
PoolIdleTimeout | The allowed idle time for a connection before it is closed. |
PoolMaxSize | The maximum connections in the pool. |
PoolMinSize | The minimum number of connections in the pool. |
PoolWaitTime | The max seconds to wait for an available connection. |
PseudoColumns | Specify a set of pseudocolumns to expose as columns. |
Readonly | You can use this property to enforce read-only access to Azure Cosmos DB from the provider. |
RequestPriorityLevel | Specifies the priority for the request sent to Azure Cosmos DB, when there are more requests than the configured RU/s in a second. |
RowScanDepth | The maximum number of rows to scan to look for the columns available in a table. |
RTK | The runtime key used for licensing. |
SeparatorCharacter | The character or characters used to denote hierarchy. |
SetPartitionKeyAsPK | Whether or not to use the collection's Partition Key field as part of composite Primary Key for the corresponding exposed table. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
TypeDetectionScheme | Comma-separated options for how the provider will scan the data to determine the fields and datatypes in each document collection. |
UseConnectionPooling | This property enables connection pooling. |
UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |
UseRidAsPk | Set this property to false to switch using the id column as primary key instead the default _rid. |
WriteThroughputBudget | Defines the Requests Units (RU) budget per Second that the Batch CUD (Create, Update, Delete) operations should not exceed. |