JDBC Driver for Salesforce

Build 22.0.8462

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
AuthSchemeThe type of authentication to use when connecting to Salesforce.
UserThe Salesforce user account used to authenticate.
PasswordThe password used to authenticate the user.
SecurityTokenThe security token used to authenticate access to the Salesforce account.
UseSandboxA boolean determining if the connection should be made to a Salesforce sandbox account.
CredentialsLocationThe location of the settings file where token retrieved with OKTA MFA is saved.

Connection


PropertyDescription
APIVersionThe version of the Salesforce API used.
LoginURLURL to the Salesforce server used for logging in.

SSO


PropertyDescription
SSOLoginURLThe identity provider's login URL.
SSOPropertiesAdditional properties required to connect to the identity provider in a semicolon-separated list.
SSOExchangeUrlThe url used for consuming the SAML response and exchanging it with Salesforce specific credentials.

BulkAPI


PropertyDescription
UseBulkAPIWhether to use the synchronous SOAP API or the asynchronous Bulk API.
BulkAPIConcurrencyModeThe concurrency mode for processing bulk rows with BULK API v1.
BulkPageSizeThe number of records to retrieve before returning results to the user when UseBulkAPI=true.
BulkPollingIntervalThe time interval in milliseconds between requests that check the availability of the bulk query response. The default value is 500 ms.
BulkQueryTimeoutThe timeout in minutes for which the provider will wait for a bulk query response. The default value is 25 minutes.
WaitForBulkResultsWhether to wait for bulk results when using the asynchronous API. Only active when UseBulkAPI is true.

ToolingAPI


PropertyDescription
UseToolingAPIWhether to use the Salesforce Tooling API.

OAuth


PropertyDescription
InitiateOAuthSet this property to initiate the process to obtain or refresh the OAuth access token when you connect.
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.
OAuthSettingsLocationThe 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://.
CallbackURLThe OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.
OAuthServerURLThe server URL to use if authenticating with OAuth.
OAuthGrantTypeThe grant type for the OAuth flow.
OAuthAuthorizationURLThe authorization URL for the OAuth service.
OAuthAccessTokenURLThe URL to retrieve the OAuth access token from.
OAuthVerifierThe verifier code returned from the OAuth authorization URL.
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.

JWT OAuth


PropertyDescription
OAuthJWTCertThe JWT Certificate store.
OAuthJWTCertTypeThe type of key store containing the JWT Certificate.
OAuthJWTCertPasswordThe password for the OAuth JWT certificate.
OAuthJWTCertSubjectThe subject of the OAuth JWT certificate.
OAuthJWTIssuerThe issuer of the Java Web Token.
OAuthJWTSubjectThe user subject for which the application is requesting delegated access.

SSL


PropertyDescription
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. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
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
AllOrNoneA boolean indicating if you would like all inserts, updates, or deletes to fail in a request if even a single record fails.
ArchiveModeBoolean indicating whether to include deleted and archived records with a standard SELECT query.
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 Salesforce when the connection is opened.
ContinueOnAlterExceptionWhether you want to continue after a ALTER statement has failed.
ExposeConceptualEntitiesBoolean determining if the Salesforce record types / conceptual entities should be exposed as tables.
FilterScopeOptional scope to limit the records returned from queries.
IncludeMetadataDescriptionSet this property to a value other than NONE if you want to retrieve the descriptions for columns, tables or both of them from the Metadata API.
MaxRowsLimits 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.
OtherThese hidden properties are used only in specific use cases.
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.
QueryPassthroughWhether to accept SOQL queries.
ReadonlyYou can use this property to enforce read-only access to Salesforce from the provider.
RemoveBOMCharacterSpecifies whether to remove the BOM character (char)0xfeff from the content.
ReplaceInvalidUTF8CharsSpecifies whether to replace invalid UTF8 characters with a '?'.
RTKThe runtime key used for licensing.
ServerSideAggregationA boolean determining if server side aggregation should be used.
SessionTimeoutThe time in minutes for which a Salesforce login session is reused.
SkipFormulaFieldsSet to true if formula fields should be skipped when listing columns.
SortColumnsSet to true to sort table columns instead of reporting them in the Salesforce order.
TimeoutThe value in seconds until the timeout error is thrown, canceling the operation.
UseConnectionPoolingThis property enables connection pooling.
UseDisplayNamesBoolean determining if the display names for the columns should be used instead of the API names.
UserDefinedViewsA filepath pointing to the JSON configuration file containing your custom views.

Copyright (c) 2023 CData Software, Inc. - All rights reserved.
Build 22.0.8462