JDBC Driver for Azure Cosmos DB

Build 22.0.8462


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

BatchSizeThe maximum size of each batch operation to submit.
CalculateAggregatesSpecifies whether will return the calculated value of the aggregates or grouped by partiton range.
ConnectionLifeTimeThe maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed.
ConnectOnOpenThis property specifies whether to connect to the Azure Cosmos DB when the connection is opened.
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.
GenerateSchemaFilesIndicates the user preference as to when schemas should be generated and saved.
MaxRowsLimits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
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.
PoolIdleTimeoutThe allowed idle time for a connection before it is closed.
PoolMaxSizeThe maximum connections in the pool.
PoolMinSizeThe minimum number of connections in the pool.
PoolWaitTimeThe max seconds to wait for an available connection.
PseudoColumnsThis property indicates whether or not to include pseudo columns as columns to the table.
ReadonlyYou can use this property to enforce read-only access to Azure Cosmos DB from the provider.
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.
UseConnectionPoolingThis property enables connection pooling.
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) 2023 CData Software, Inc. - All rights reserved.
Build 22.0.8462