CData Python Connector for Azure Cosmos DB

Build 25.0.9454

Miscellaneous

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.


PropertyDescription
CalculateAggregatesSpecifies whether will return the calculated value of the aggregates or grouped by partiton range.
ConsistencyLevelDenotes the type of token: master or resource.
FlattenArraysBy 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.
FlattenObjectsSet FlattenObjects to true to flatten object properties into columns of their own. Otherwise, objects nested in arrays are returned as strings of JSON.
ForceQueryOnNonIndexedContainersForce the use of an index scan to process the query if indexing is disabled or the right index path is not available.
GenerateSchemaFilesIndicates the user preference as to when schemas should be generated and saved.
MaxRowsSpecifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
MaxThreadsSpecifies the maximum number of concurrent requests for Batch CUD (Create, Update, Delete) operations.
MultiThreadCountAggregate 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.
OtherSpecifies additional hidden properties for specific use cases., to be used only when our Support team advises it, to address specific issues. See Remarks for details.
PagesizeSpecifies the maximum number of records per page the provider returns when requesting data from Azure Cosmos DB.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
ReadonlyToggles read-only access to Azure Cosmos DB from the provider.
RequestPriorityLevelSpecifies the priority level for requests sent to Azure Cosmos DB when the number of requests exceeds the configured RU/s within a second.
RowScanDepthThe maximum number of rows to scan to look for the columns available in a table.
RTKSpecifies the runtime key for licensing the provider. If unset or invalid, the provider defaults to the standard licensing method. This property is only required in environments where the standard licensing method is unsupported or requires a runtime key.
SeparatorCharacterThe character or characters used to denote hierarchy.
SetPartitionKeyAsPKWhether or not to use the collection's Partition Key field as part of composite Primary Key for the corresponding exposed table.
TimeoutSpecifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
TypeDetectionSchemeComma-separated options for how the provider will scan the data to determine the fields and datatypes in each document collection.
UserDefinedViewsSpecifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.
UseRidAsPkSet this property to false to switch using the id column as primary key instead the default _rid.
WriteThroughputBudgetDefines the Requests Units (RU) budget per Second that the Batch CUD (Create, Update, Delete) operations should not exceed.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9454