CData ADO.NET Provider for JSON 2017 - Online Help
Questions / Feedback?

Connection String Options

CData ADO.NET Provider for JSON 2017 - Build 17.0.6634

Connection String Options  

The 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 SchemeThe scheme used for authentication. Accepted entries are NTLM, BASIC, DIGEST, NONE, or KERBEROSDELEGATION.
Auto CacheAutomatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider . Configured with CacheQueryResult .
Cache ConnectionThe 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 LocationSpecifies the path to the cache when caching to a file.
Cache MetadataWhether or not to cache the table metadata to a file store.
Cache ProviderThe name of the provider to be used to cache data.
Cache Query ResultWith 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 URLThe OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.
Custom HeadersOther headers as determined by the user (optional).
Custom Url ParamsThe custom query string to be included in the request.
Firewall PasswordA password used to authenticate to a proxy-based firewall.
Firewall PortThe TCP port for a proxy-based firewall.
Firewall ServerThe name or IP address of a proxy-based firewall.
Firewall TypeThe protocol used by a proxy-based firewall.
Firewall UserThe user name to use to authenticate with a proxy-based firewall.
Generate Schema FilesSpecifies whether to generate a schema file (RSD) from the parsed JSON document.
Initiate OAuthSet this property to initiate the process to obtain or refresh the OAuth access token when you connect.
JSON PathThe JSONPath of an array element within the JSON document (used to split the document into multiple rows).
LocationA path to the directory that contains the schema files defining tables, views, and stored procedures.
LogfileA path to the log file.
Max Log File SizeA 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 TokenThe access token for connecting using OAuth.
OAuth Access Token SecretThe OAuth access token secret for connecting using OAuth.
OAuth Access Token URLThe URL to retrieve the OAuth access token from.
OAuth Authorization URLThe authorization URL for the OAuth service.
OAuth Client IdThe client Id assigned when you register your application with an OAuth authorization server.
OAuth Client SecretThe client secret assigned when you register your application with an OAuth authorization server.
OAuth Grant TypeThe grant type for the OAuth flow.
OAuth ParamsA comma-separated list of other parameters to submit in the request for the OAuth access token in the format paramname=value.
OAuth Refresh TokenThe OAuth refresh token for the corresponding OAuth access token.
OAuth Refresh Token URLThe URL to refresh the OAuth token from.
OAuth Request Token URLThe URL the service provides to retrieve request tokens from. Required in OAuth 1.0.
OAuth Settings LocationThe location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH.
OAuth VersionThe version of OAuth being used.
OfflineUse offline mode to get the data from the cache instead of the live source.
OtherThe other parameters necessary to connect to a data source, such as username and password, when applicable.
PasswordThe password used to connect to a remote data source using HTTP.
Pool Idle TimeoutThe allowed idle time for a connection.
Pool Max SizeThe maximum connections in the pool.
Pool Wait TimeThe max seconds to wait for an available connection.
Proxy Auth SchemeThe authentication type to use to authenticate to the ProxyServer proxy.
Proxy Auto DetectThis 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 ExceptionsA semicolon separated list of hosts or IPs that will be exempt from connecting through the ProxyServer .
Proxy PasswordA password to be used to authenticate to the ProxyServer proxy.
Proxy PortThe TCP port the ProxyServer proxy is running on.
Proxy ServerThe hostname or IP address of a proxy to route HTTP traffic through.
Proxy SSL TypeThe SSL type to use when connecting to the ProxyServer proxy.
Proxy UserA user name to be used to authenticate to the ProxyServer proxy.
Pseudo ColumnsIndicates whether or not to include pseudo columns as columns to the table.
ReadonlyYou can use this property to enforce read-only access to JSON from the provider.
Row Scan DepthThe number of rows to scan when dynamically determining columns for the table.
RTKThe runtime key used for licensing.
SSL Server CertThe certificate to be accepted from the server when connecting using TLS/SSL.
Support Enhanced SQLEnhances SQL functionality beyond what can be supported through the API directly, by enabling in-memory client-side processing.
TablesRestrict the tables reported to a subset of the available tables. For example: Tables=TableA,TableB,TableC.
TimeoutThe value in seconds until the timeout error is thrown, canceling the operation.
URIThe Uniform Resource Identifier (URI) of the JSON resource.
Use Connection PoolingEnables connection pooling.
UserThe username that will be used to connect to a remote data source using HTTP.
VerbosityThe verbosity level that determines the amount of detail included in the log file.
ViewsRestrict the views reported to a subset of the available tables. For example: Views=ViewsA,ViewsB,ViewsC.

 
 
Copyright (c) 2018 CData Software, Inc. - All rights reserved.
Build 17.0.6634.0