Connection String Options
The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.
For more information on establishing a connection, see Establishing a Connection.| Account Endpoint | The value should be the Cosmos DB account URL from the Keys blade of the Cosmos DB account. |
| Account Key | A master key token or a resource token for connecting to the Cosmos DB REST API. |
| Auto Cache | Automatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider . |
| Batch Size | The maximum size of each batch operation to submit. |
| Cache Connection | The connection string for the cache database. This property is always used in conjunction with CacheProvider . Setting both properties will override the value set for CacheLocation for caching data. |
| Cache Driver | The database driver to be used to cache data. |
| Cache Location | Specifies the path to the cache when caching to a file. |
| Cache Metadata | This property determines whether or not to cache the table metadata to a file store. |
| Cache Tolerance | The tolerance for stale data in the cache specified in seconds when using AutoCache . |
| Calculate Aggregates | Specifies whether will return the calculated value of the aggregates or grouped by partiton range. |
| Connection Life Time | The maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed. |
| Connect On Open | This property species whether to connect to the Cosmos DB when the connection is opened. |
| Consistency Level | Denotes the type of token: master or resource. |
| Firewall Password | A password used to authenticate to a proxy-based firewall. |
| Firewall Port | The TCP port for a proxy-based firewall. |
| Firewall Server | The name or IP address of a proxy-based firewall. |
| Firewall Type | The protocol used by a proxy-based firewall. |
| Firewall User | The user name to use to authenticate with a proxy-based firewall. |
| Flatten Arrays | 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. |
| Flatten Objects | Set FlattenObjects to true to flatten object properties into columns of their own. Otherwise, objects nested in arrays are returned as strings of JSON. |
| Generate Schema Files | Indicates the user preference as to when schemas should be generated and saved. |
| Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
| Logfile | A filepath which designates the name and location of the log file. |
| Log Modules | Core modules to be included in the log file. |
| Max Log File Count | A string specifying the maximum file count of log files. When the limit is hit, a new log is created in the same folder with the date and time appended to the end and the oldest log file will be deleted. |
| Max Log File Size | A string specifying the maximum size in bytes for a log file (for example, 10 MB). When the limit is hit, a new log is created in the same folder with the date and time appended to the end. |
| Max Rows | Limits 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. |
| Multi Thread Count | 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. |
| Offline | Use offline mode to get the data from the cache instead of the live source. |
| Other | These hidden properties are used only in specific use cases. |
| Pool Idle Timeout | The allowed idle time for a connection before it is closed. |
| Pool Max Size | The maximum connections in the pool. |
| Pool Min Size | The minimum number of connections in the pool. |
| Pool Wait Time | The max seconds to wait for an available connection. |
| Proxy Auth Scheme | The authentication type to use to authenticate to the ProxyServer proxy. |
| Proxy Auto Detect | This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings. |
| Proxy Exceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer . |
| Proxy Password | A password to be used to authenticate to the ProxyServer proxy. |
| Proxy Port | The TCP port the ProxyServer proxy is running on. |
| Proxy Server | The hostname or IP address of a proxy to route HTTP traffic through. |
| Proxy SSL Type | The SSL type to use when connecting to the ProxyServer proxy. |
| Proxy User | A user name to be used to authenticate to the ProxyServer proxy. |
| Pseudo Columns | This property indicates whether or not to include pseudo columns as columns to the table. |
| Readonly | You can use this property to enforce read-only access to Cosmos DB from the provider. |
| Row Scan Depth | The maximum number of rows to scan to look for the columns available in a table. |
| RTK | The runtime key used for licensing. |
| Schema | Specify the Cosmos DB database you want to work with. |
| Separator Character | The character or characters used to denote hierarchy. |
| SSL Client Cert | The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL). |
| SSL Client Cert Password | The password for the TLS/SSL client certificate. |
| SSL Client Cert Subject | The subject of the TLS/SSL client certificate. |
| SSL Client Cert Type | The type of key store containing the TLS/SSL client certificate. |
| SSL Server Cert | The certificate to be accepted from the server when connecting using TLS/SSL. |
| Support Enhanced SQL | This property enhances SQL functionality beyond what can be supported through the API directly, by enabling in-memory client-side processing. |
| Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC. |
| Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
| Token Type | Denotes the type of token: master or resource. |
| Type Detection Scheme | Comma-separated options for how the provider will scan the data to determine the fields and datatypes in each document collection. |
| Use Connection Pooling | This property enables connection pooling. |
| Verbosity | The verbosity level that determines the amount of detail included in the log file. |
| Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC. |