JDBC Driver for OData

Build 23.0.8839

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.

Authentication


PropertyDescription
URLURL to the Organization root or the OData services file. For example, http://MySite/MyOrganization.
AuthSchemeThe scheme used for authentication. Accepted entries are NTLM, BASIC, DIGEST, NONE, NEGOTIATE, or SHAREPOINTONLINE.
UserThe OData user account used to authenticate.
PasswordThe password used to authenticate the user.
FeedURLURL to the OData entity set. For example, http://MySite/MyOrganization/EntitySet.
SharePointUseSSOWhether or not to use single sign-on (SSO) to authenticate to SharePoint Online.

Azure Authentication


PropertyDescription
AzureADTenantThe Azure Active Directory tenant to authenticate against (only used with Azure AD OAuth).
AzureTenantThe Microsoft Online tenant being used to access data. If not specified, your default tenant is used.
AzureResourceThe Azure Active resource to authenticate to (used during Azure OAuth exchange).

SSO


PropertyDescription
SharePointSSODomainThe domain of the user when using single sign-on (SSO).

OAuth


PropertyDescription
InitiateOAuthSet this property to initiate the process to obtain or refresh the OAuth access token when you connect.
OAuthVersionThe version of OAuth being used.
OAuthClientIdThe client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecretThe client secret assigned when you register your application with an OAuth authorization server.
OAuthAccessTokenThe access token for connecting using OAuth.
OAuthAccessTokenSecretThe OAuth access token secret for connecting using OAuth.
OAuthSettingsLocationThe location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH . Alternatively, you can hold this location in memory by specifying a value starting with 'memory://'.
CallbackURLThe OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.
OAuthGrantTypeThe grant type for the OAuth flow.
OAuthPasswordGrantModeHow to pass Client Id and Secret with OAuthGrantType is set to Password.
OAuthIncludeCallbackURLWhether to include the callback URL in an access token request.
OAuthAuthorizationURLThe authorization URL for the OAuth service.
OAuthAccessTokenURLThe URL to retrieve the OAuth access token from.
OAuthRefreshTokenURLThe URL to refresh the OAuth token from.
OAuthRequestTokenURLThe URL the service provides to retrieve request tokens from. This is required in OAuth 1.0.
OAuthVerifierThe verifier code returned from the OAuth authorization URL.
AuthTokenThe authentication token used to request and obtain the OAuth Access Token.
AuthKeyThe authentication secret used to request and obtain the OAuth Access Token.
OAuthParamsA comma-separated list of other parameters to submit in the request for the OAuth access token in the format paramname=value.
OAuthRefreshTokenThe OAuth refresh token for the corresponding OAuth access token.
OAuthExpiresInThe lifetime in seconds of the OAuth AccessToken.
OAuthTokenTimestampThe Unix epoch timestamp in milliseconds when the current Access Token was created.

Kerberos


PropertyDescription
KerberosKDCThe Kerberos Key Distribution Center (KDC) service used to authenticate the user.
KerberosRealmThe Kerberos Realm used to authenticate the user.
KerberosSPNThe service principal name (SPN) for the Kerberos Domain Controller.
KerberosKeytabFileThe Keytab file containing your pairs of Kerberos principals and encrypted keys.
KerberosServiceRealmThe Kerberos realm of the service.
KerberosServiceKDCThe Kerberos KDC of the service.
KerberosTicketCacheThe full file path to an MIT Kerberos credential cache file.

SSL


PropertyDescription
SSLClientCertThe TLS/SSL client certificate store for SSL Client Authentication (2-way SSL).
SSLClientCertTypeThe type of key store containing the TLS/SSL client certificate.
SSLClientCertPasswordThe password for the TLS/SSL client certificate.
SSLClientCertSubjectThe subject of the TLS/SSL client certificate.
SSLServerCertThe certificate to be accepted from the server when connecting using TLS/SSL.

Firewall


PropertyDescription
FirewallTypeThe protocol used by a proxy-based firewall.
FirewallServerThe name or IP address of a proxy-based firewall.
FirewallPortThe TCP port for a proxy-based firewall.
FirewallUserThe user name to use to authenticate with a proxy-based firewall.
FirewallPasswordA password used to authenticate to a proxy-based firewall.

Proxy


PropertyDescription
ProxyAutoDetectThis indicates whether to use the system proxy settings or not.
ProxyServerThe hostname or IP address of a proxy to route HTTP traffic through.
ProxyPortThe TCP port the ProxyServer proxy is running on.
ProxyAuthSchemeThe authentication type to use to authenticate to the ProxyServer proxy.
ProxyUserA user name to be used to authenticate to the ProxyServer proxy.
ProxyPasswordA password to be used to authenticate to the ProxyServer proxy.
ProxySSLTypeThe SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptionsA semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Logging


PropertyDescription
LogfileA filepath which designates the name and location of the log file.
VerbosityThe verbosity level that determines the amount of detail included in the log file.
LogModulesCore modules to be included in the log file.
MaxLogFileSizeA string specifying the maximum size in bytes for a log file (for example, 10 MB).
MaxLogFileCountA string specifying the maximum file count of log files.

Schema


PropertyDescription
LocationA path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemasThis property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
TablesThis property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
ViewsRestricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Caching


PropertyDescription
AutoCacheAutomatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider .
CacheDriverThe database driver used to cache data.
CacheConnectionThe 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.
CacheLocationSpecifies the path to the cache when caching to a file.
CacheToleranceThe tolerance for stale data in the cache specified in seconds when using AutoCache .
OfflineUse offline mode to get the data from the cache instead of the live source.
CacheMetadataThis property determines whether or not to cache the table metadata to a file store.

Miscellaneous


PropertyDescription
BatchSizeThe maximum size of each batch operation to submit.
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 OData when the connection is opened.
ContinueOnErrorWhether 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.
CustomHeadersOther headers as determined by the user (optional).
CustomUrlParamsThe custom query string to be included in the request.
DataFormatThe data format to retrieve data in. Select either ATOM or JSON.
EnableAtomicBatchOperationsWhether or not the CData ADO.NET Provider for OData should use atomic batch operations.
ExpandAsteriskIndicates whether the asterisk should be expanded in the $select query parameter.
IncludeNavigationParentColumnsIndicates if navigation parent columns should be included on navigation views.
IncludeReferenceColumnAdds a input only ParentReference column for bulk INSERTs to properly associate children during a deep insert with the same parent.
MaxFilterLengthThe maximum number of characters for the $filter query parameter.
MaxRowsLimits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
MaxSelectLengthThe maximum number of characters for the $Select query parameter.
NavigationPropertiesAsViewsA boolean indicating navigation properties should be promoted to full views.
ODataVersionThe version of OData to use. By default the provider will attempt to autodetect the version.
OtherThese hidden properties are used only in specific use cases.
PagesizeThe maximum number of results to return per page from OData.
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 OData from the provider.
RTKThe runtime key used for licensing.
ServerTimeZoneThe timezone by which the server's Edm.DateTime values are represented. The value of this property will affect how Edm.DateTime filters and results are converted between the server and the client machine.
StoredProceduresAsViewsA boolean indicating if we should list stored procedures which return a collection of entities as views.
SupportsExpandWhether you need to specify the base entity's key to query navigation property views.
SupportsFilterSet this to true if your OData service supports filters.
SupportsFormulasA boolean indicating if the odata service supports server side formulas.
TimeoutThe value in seconds until the timeout error is thrown, canceling the operation.
UseClientSidePagingWhether or not the CData ADO.NET Provider for OData should use client side paging.
UseConnectionPoolingThis property enables connection pooling.
UseEtagsWhether or not the OData source uses Etags.
UserDefinedViewsA filepath pointing to the JSON configuration file containing your custom views.
UseSimpleNamesBoolean determining if simple names should be used for tables and columns.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 23.0.8839