Connection String Options
CData ADO.NET Provider for JSON 2017 - Build 17.0.6634The connection string properties describe the various options that can be used to establish a connection.
Assembly
System.Data.CData.JSON.dll
Remarks
The connection string can be set to a series of "option=value" pairs, separated by semicolons. If a connection string property value has special characters such as semicolons, single quotes, spaces, etc., then you must quote the value using either single or double quotes.
Connection options are case insensitive.
To specify a location to the database where the tables, views and stored procedures are located, set the Location.
Connection String Options
The following is the full list of the options you can configure in the connection string for this provider. Click on the links for further details.
| Auth Scheme | The scheme used for authentication. Accepted entries are NTLM, BASIC, DIGEST, NONE, or KERBEROSDELEGATION. |
| Auto Cache | Automatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider . Configured with CacheQueryResult . |
| Cache Connection | The connection string for the cache database. Always used in conjunction with CacheProvider . Setting both properties will override the value set for CacheLocation for caching data. |
| Cache Location | Specifies the path to the cache when caching to a file. |
| Cache Metadata | Whether or not to cache the table metadata to a file store. |
| Cache Provider | The name of the provider to be used to cache data. |
| Cache Query Result | With AutoCache set, caches each row read from a SELECT query's results. Without this, the provider will attempt to fully replicate the table before executing the actual query against the replication database. |
| Callback URL | The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings. |
| Custom Headers | Other headers as determined by the user (optional). |
| Custom Url Params | The custom query string to be included in the request. |
| 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. |
| Generate Schema Files | Specifies whether to generate a schema file (RSD) from the parsed JSON document. |
| Initiate OAuth | Set this property to initiate the process to obtain or refresh the OAuth access token when you connect. |
| JSON Path | The JSONPath of an array element within the JSON document (used to split the document into multiple rows). |
| Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
| Logfile | A path to the log file. |
| Max Log File Size | A string specifying the maximum size in bytes for a log file (ex: 10MB). When the limit is hit, a new log is created in the same folder with the date and time appended to the end. |
| OAuth Access Token | The access token for connecting using OAuth. |
| OAuth Access Token Secret | The OAuth access token secret for connecting using OAuth. |
| OAuth Access Token URL | The URL to retrieve the OAuth access token from. |
| OAuth Authorization URL | The authorization URL for the OAuth service. |
| OAuth Client Id | The client Id assigned when you register your application with an OAuth authorization server. |
| OAuth Client Secret | The client secret assigned when you register your application with an OAuth authorization server. |
| OAuth Grant Type | The grant type for the OAuth flow. |
| OAuth Params | A comma-separated list of other parameters to submit in the request for the OAuth access token in the format paramname=value. |
| OAuth Refresh Token | The OAuth refresh token for the corresponding OAuth access token. |
| OAuth Refresh Token URL | The URL to refresh the OAuth token from. |
| OAuth Request Token URL | The URL the service provides to retrieve request tokens from. Required in OAuth 1.0. |
| OAuth Settings Location | The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH. |
| OAuth Version | The version of OAuth being used. |
| Offline | Use offline mode to get the data from the cache instead of the live source. |
| Other | The other parameters necessary to connect to a data source, such as username and password, when applicable. |
| Password | The password used to connect to a remote data source using HTTP. |
| Pool Idle Timeout | The allowed idle time for a connection. |
| Pool Max Size | The maximum 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. Set ProxyAutoDetect to FALSE to use custom proxy settings. This takes precedence over other proxy settings. |
| Proxy Exceptions | A semicolon separated list of hosts or IPs that will be 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 | 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 JSON from the provider. |
| Row Scan Depth | The number of rows to scan when dynamically determining columns for the table. |
| RTK | The runtime key used for licensing. |
| SSL Server Cert | The certificate to be accepted from the server when connecting using TLS/SSL. |
| Support Enhanced SQL | Enhances SQL functionality beyond what can be supported through the API directly, by enabling in-memory client-side processing. |
| Tables | Restrict 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. |
| URI | The Uniform Resource Identifier (URI) of the JSON resource. |
| Use Connection Pooling | Enables connection pooling. |
| User | The username that will be used to connect to a remote data source using HTTP. |
| Verbosity | The verbosity level that determines the amount of detail included in the log file. |
| Views | Restrict the views reported to a subset of the available tables. For example: Views=ViewsA,ViewsB,ViewsC. |