You can use connection properties to customize the driver for your environment. This section lists the connection properties supported by the driver and describes each property. You can use these connection properties with either the JDBC DriverManager or a JDBC DataSource. For a DriverManager connection, a property is expressed as a key value pair and takes the form property=value. For a data source connection, a property is expressed as a JDBC method and takes the form setproperty(value).

Note:
  • In a JDBC data source, string values must be enclosed in double quotation marks, for example, setUser("abc@defcorp.com").
  • The data type listed for each connection property is the Java data type used for the property value in a JDBC data source.
  • Connection property names are case-insensitive. For example, Password is the same as password.
  • For connection properties that support string values, use the following escape sequence to specify values containing leading or trailing spaces and curly brackets: {value}. For example: User={hello } or Password={{hello}}.

The following table provides a summary of the connection properties supported by the driver, their corresponding data source methods, and their default values.

Table 1. Salesforce Driver Properties
Property Data Source Method Default
AccessToken setAccessToken None
ApplyToLabel setApplyToLabel false
AuthenticationMethod setAuthenticationMethod userIDPassword
BulkFetchThreshold setBulkFetchThreshold 30000 (rows)
BulkLoadAsync setBulkLoadAsync 0 (bulk load operations are synchronous)
BulkLoadBatchSize setBulkLoadBatchSize 10000 (rows)
BulkLoadConcurrencyMode setBulkLoadConcurrencyMode parallel
BulkLoadJobSize setBulkLoadJobSize 150000
BulkLoadPollInterval setBulkLoadPollInterval 10 (seconds)
BulkLoadThreshold setBulkLoadThreshold 4000 (rows)
BulkLoadVersion setBulkLoadVersion V1
CatalogOptions setCatalogOptions 2
ClaimsIssuer setClaimsIssuer None
ClaimsSubject setClaimsSubject None
ClientID setClientID None
ClientSecret setClientSecret None
ClientTimeZone setClientTimeZone None. The driver determines the client time zone based on the system-specific time zone settings.
ConfigOptions
Important: The configuration options have been deprecated. However, the driver will continue to support them until the next major release of the driver.
setConfigOptions
AuditColumns=all;
CustomSuffix=include;
KeywordConflictSuffix=;
MapSystemColumnNames=0;
NumberFieldMapping=emulateInteger;
UppercaseIdentifiers=true
ConnectionRetryCount setConnectionRetryCount 5
ConnectionRetryDelay setConnectionRetryDelay 1 (second)
ConvertNull setConvertNull 1 (data type check is performed if column value is null)
CreateMap setCreateMap notExist
EnableBulkFetch setEnableBulkFetch true
EnableBulkLoad setEnableBulkLoad true
EnablePKChunking setEnablePKChunking true
FetchSize setFetchSize 100 (rows)
ImportStatementPool setImportStatementPool empty string
InitializationString setInitializationString None
InsensitiveResultSetBufferSize setInsensitiveResultSetBufferSize 2048 (KB of memory)
InValuesLimit setInValuesLimit 200
JavaDoubleToString setJavaDoubleToString false
JWTCertAlias setJwtCertAlias None
JWTCertPassword setJwtCertPassword None
JWTCertStore setJwtCertStore None
LogConfigFile setLogConfigFile ddlogging.properties
LoginTimeout setLoginTimeout 0 (no timeout)
MaxPooledStatements setMaxPooledStatements 0 (driver’s internal prepared statement pooling is not enabled)
Password setPassword None
PKChunkSize setPKChunkSize 100000 (rows)
ProxyHost setProxyHost empty string
ProxyPassword setProxyPassword empty string
ProxyPort setProxyPort 0
ProxyUser setProxyUser empty string
ReadOnly setReadyOnly false
RefreshToken setRefreshToken None
RegisterStatementPoolMonitorMBean setRegisterStatementPoolMonitorMBean false
SchemaMap setSchemaMap Default value depends on environment
SecurityToken setSecurityToken None
ServerName setServerName login.salesforce.com
SpyAttributes setSpyAttributes None
StmtCallLimit setStmtCallLimit 100 (Web service calls)
StmtCallLimitBehavior setStmtCallLimitBehavior errorAlways
TransactionMode setTransactionMode noTransactions
User setUser None
WSCompressData setWSCompressData compress
WSFetchSize setWSFetchSize 0 (maximum of 2000 rows)
WSPoolSize setWSPoolSize 1
WSRetryCount setWSRetryCount 0 (no retries for timed-out requests)
WSTimeout setWSTimeout 120 (seconds)