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

Connection String Options

CData JDBC Driver for Salesforce 2019 - Build 19.0.7362

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.
All Or NoneA boolean indicating if you would like all inserts, updates, or deletes to fail in a request if even a single record fails.
API VersionThe version of the Salesforce API used.
Auto CacheAutomatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider .
Bulk Polling IntervalThe time interval in milliseconds between requests that check the availability of the bulk query response. The default value is 500 ms.
Bulk Query TimeoutThe timeout in minutes for which the provider will wait for a bulk query response. The default value is 25 minutes.
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 Salesforce when the connection is opened.
Continue On Alter ExceptionWhether you want to continue after a ALTER statement has failed.
Filter ScopeOptional scope to limit the records returned from queries.
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.
Initiate OAuthSet this property to initiate the process to obtain or refresh the OAuth access token when you connect.
LocationA path to the directory that contains the schema files defining tables, views, and stored procedures.
LogfileA path to the log file.
Login URLURL to the Salesforce server used for logging in.
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.
OAuth Access TokenThe access token for connecting using OAuth.
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 Refresh TokenThe OAuth refresh token for the corresponding OAuth access token.
OAuth Server UrlThe server URL to use if authenticating with OAuth.
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.
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.
PasswordThe password of the Salesforce account used to authenticate to the Salesforce server.
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 destination hostnames 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 Salesforce from the provider.
RTKThe runtime key used for licensing.
Security TokenThe security token used to authenticate access to the Salesforce account.
Server Side AggregationA boolean determining if server side aggregation should be used.
Server UrlThe Salesforce instance url.
Session TimeoutThe time in minutes for which a Salesforce login session is reused.
SSL Server CertThe certificate to be accepted from the server when connecting using TLS/SSL.
SSO Login UrlThe identity provider's login URL.
SSO PropertiesAdditional properties required to connect to the identity provider in a semicolon-separated list.
SSO Token UrlThe Salesforce OAuth 2.0 token endpoint for the identity provider.
Support Enhanced SQLThis property enhances SQL functionality beyond what can be supported through the API directly, by enabling in-memory client-side processing.
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.
Use Bulk APIWhether to use the synchronous SOAP API or the asynchronous Bulk API.
Use Connection PoolingThis property enables connection pooling.
UserThe user name of the Salesforce account used to authenticate to the server.
Use SandboxA boolean determining if the connection should be made to a Salesforce sandbox account.
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.
Wait For Bulk ResultsWhether to wait for bulk results when using the asynchronous API. Only active when UseBulkAPI is true.

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