ODBC Driver for Azure Cosmos DB

Build 24.0.9060

Miscellaneous

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


PropertyDescription
BatchSizeThe maximum size of each batch operation to submit.
CalculateAggregatesSpecifies whether will return the calculated value of the aggregates or grouped by partiton range.
ConsistencyLevelDenotes the type of token: master or resource.
DefaultDomainThis property is used for the Oracle Database Gateway for ODBC.
EnableForeignKeyDetectionWhether to detect the foreign keys in ODBC.
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.
IncludeDualTableSet this property to mock the Oracle DUAL table for better compatibility with Oracle database.
LimitKeySizeThe maximum length of a primary key column.
MapBigintToVarcharThis property controls whether or not the bigint type maps to SQL_VARCHAR instead of SQL_BIGINT. This property is false by default.
MapToIntThis property controls whether or not the long type maps to SQL_INTEGER instead of SQL_BIGINT. This property is false by default.
MapToLongVarcharThis property controls whether or not a column is returned as SQL_LONGVARCHAR.
MapToWVarcharThis property controls whether or not string types map to SQL_WVARCHAR instead of SQL_VARCHAR. This property is set by default.
MaximumColumnSizeThe maximum column size.
MaxRowsLimits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
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.
OtherThese hidden properties are used only in specific use cases.
PagesizeThe maximum number of results to return per page from Azure Cosmos DB.
PseudoColumnsSpecify a set of pseudocolumns to expose as columns.
ReadonlyYou can use this property to enforce read-only access to Azure Cosmos DB from the provider.
RequestPriorityLevelSpecifies the priority for the request sent to Azure Cosmos DB, when there are more requests than the configured RU/s in a second.
RowScanDepthThe maximum number of rows to scan to look for the columns available in a table.
RTKThe runtime key used for licensing.
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.
TimeoutThe value in seconds until the timeout error is thrown, canceling the operation.
TypeDetectionSchemeComma-separated options for how the provider will scan the data to determine the fields and datatypes in each document collection.
UpperCaseIdentifiersThis property reports all identifiers in uppercase. This is the default for Oracle databases and thus allows better integration with Oracle tools such as the Oracle Database Gateway.
UserDefinedViewsA filepath pointing to the JSON configuration file containing your custom views.
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) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060