CData JDBC Driver for OData 2019 - Online Help
Questions / Feedback?

Connection String Options

CData JDBC Driver for OData 2019 - Build 19.0.7354

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.
Auth SchemeThe scheme used for authentication. Accepted entries are NTLM, BASIC, DIGEST, NONE, NEGOTIATE, or SHAREPOINTONLINE.
Auto CacheAutomatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider .
Azure AD ResourceThe Azure Active Directory resource to authenticate to (only used with Azure AD OAuth).
Azure AD TenantThe Azure Active Directory tenant to authenticate against (only used with Azure AD OAuth).
Batch SizeThe maximum size of each batch operation to submit.
Cache ConnectionThe 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 DriverThe database driver to be used to cache data.
Cache LocationSpecifies the path to the cache when caching to a file.
Cache MetadataThis property determines whether or not to cache the table metadata to a file store.
Cache ToleranceThe tolerance for stale data in the cache specified in seconds when using AutoCache .
Callback URLThe OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.
Connection Life TimeThe maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed.
Connect On OpenThis property species whether to connect to the OData when the connection is opened.
Continue On ErrorWhether or not to continue after encountering an error on a batch request.
CookiesAllows cookies to be manually specified in name=value pairs separated by a semicolon.
Custom HeadersOther headers as determined by the user (optional).
Custom Url ParamsThe custom query string to be included in the request.
Data FormatThe data format to retrieve data in. Select either ATOM or JSON.
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.
Include Navigation Parent ColumnsIndicates if navigation parent columns should be included on navigation views.
Initiate OAuthSet this property to initiate the process to obtain or refresh the OAuth access token when you connect.
Kerberos SPNThe service principal name for the Kerberos domain controller.
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 CountA 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 SizeA 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 RowsLimits 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.
Navigation Properties As ViewsA boolean indicating navigation properties should be promoted to full views.
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. Can be either CLIENT, CODE or PASSWORD.
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. Alternatively, this can be held in memory by specifying a value starting with memory://.
OAuth VerifierThe verifier code returned from the OAuth authorization URL.
OAuth VersionThe version of OAuth being used. Enter 1.0 or 2.0.
OData VersionThe version of OData to use. By default the provider will attempt to autodetect the version.
OfflineUse offline mode to get the data from the cache instead of the live source.
OtherThese hidden properties are used only in specific use cases.
PagesizeThe maximum number of results to return per page from OData when UseClientSidePaging is true.
PasswordThe password used to authenticate to the OData site.
Pool Idle TimeoutThe allowed idle time for a connection before it is closed.
Pool Max SizeThe maximum connections in the pool.
Pool Min SizeThe minimum number of 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. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
Proxy ExceptionsA semicolon separated list of hosts or IPs that are 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 ColumnsThis 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 OData from the provider.
RTKThe runtime key used for licensing.
SSL Client CertThe TLS/SSL client certificate store for SSL Client Authentication (2-way SSL).
SSL Client Cert PasswordThe password for the TLS/SSL client certificate.
SSL Client Cert SubjectThe subject of the TLS/SSL client certificate.
SSL Client Cert TypeThe type of key store containing the TLS/SSL client certificate.
SSL Server CertThe certificate to be accepted from the server when connecting using TLS/SSL.
Support Enhanced SQLThis property enhances SQL functionality beyond what can be supported through the API directly, by enabling in-memory client-side processing.
Supports ExpandWhether you need to specify the base entity's key to query navigation property views.
Supports FormulasA boolean indicating if the odata service supports server side formulas.
TablesThis property restricts 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.
URLURL to the Organization root or the OData services file. For example, http://MySite/MyOrganization.
Use Client Side PagingWhether or not the CData ADO.NET Provider for OData should use client side paging.
Use Connection PoolingThis property enables connection pooling.
Use EtagsWhether or not the OData source uses Etags.
UserThe user who is authenticating to the OData site.
Use Simple NamesWhether or not to use simple names for tables and columns.
VerbosityThe verbosity level that determines the amount of detail included in the log file.
ViewsRestricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Copyright (c) 2020 CData Software, Inc. - All rights reserved.
Build 19.0.7354.0