You can use connection properties to customize the driver for your environment. This section organizes connection properties according to functionality. You can use connection properties with either the JDBC DriverManager or a JDBC data source. 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 tables describe the connection properties by functionality.

General properties

The following table summarizes the properties that are required for every connection.

Property Data Source Method Default
AccountName getAccountName()

setAccountName(String)

 No default value
AuthenticationMethod getAuthenticationMethod()

setAuthenticationMethod(String)

 UserIDPassword
DatabaseName getDatabaseName()

setDatabaseName(String)

 No default value
Schema getSchema()

setSchema(String)

 No default value
Warehouse getWarehouse()

setWarehouse(String)

 No default value

UserID/Password authentication properties

The following table summarizes properties used for UserID/Password authentication method.

Property Data Source Method Default
Password getPassword()

setPassword(String)

 No default value
User getUser()

setUser(String)

 No default value

OAuth 2.0 authentication properties

The following table summarizes properties used for OAuth 2.0 authentication method.

Property Data Source Method Default
AccessToken getAccessToken()

setAccessToken(String)

 No default value
AuthURI getAuthUri()

setAuthUri(String)

 No default value
ClientID getClientId()

setClientId(String)

 No default value
ClientSecret getClientSecret()

setClientSecret(String)

 No default value
OAuthCode getCode()

setCode(String)

 No default value
RedirectURI getRedirUri()

setRedirUri(String)

 No default value
RefreshToken getRefreshToken()

setRefreshToken(String)

 No default value
Scope getScope()

setScope(String)

 No default value
TokenURI getTokenUri()

setTokenUri(String)

 No default value

Key-pair authentication properties

The following table summarizes the properties used for key-pair authentication method.

Property Data Source Method Default
AuthenticationMethod getAuthenticationMethod()

setAuthenticationMethod(String)

 UserIDPassword
PrivateKeyContent getPrivateKeyContent()

setPrivateKeyContent(String)

 No default value
PrivateKeyFile getPrivateKeyFile()

setPrivateKeyFile(String)

 No default value
PrivateKeyPassphrase getPrivateKeyPassphrase()

setPrivateKeyPassphrase(String)

 No default value

Proxy server properties

The following table summarizes proxy server connection properties.

Property Data Source Method Default
ProxyHost getProxyHost()

setProxyHost(String)

 No default value
ProxyPassword getProxyPassword()

setProxyPassword(String)

 No default value
ProxyPort getProxyPort()

setProxyPort(Integer)

 0 which means the default is determined by the ProxyHost property.

For HTTP URLs: 80

For HTTPS URLs: 443
ProxyUser getProxyUser()

setProxyUser(String)

 No default value

Data type properties

The following table summarizes connection properties which can be used to handle data types.

Table 1. Data Type Properties
Property Data Source Method Default
ConvertNull getConvertNull()

setConvertNull(Boolean)

 true

Timeout properties

The following table summarizes timeout connection properties.

Property Data Source Method Default
LoginTimeout getLoginTimeout()

setLoginTimeout(Integer)

 60
QueryTimeout getQueryTimeout()

setQueryTimeout(Integer)

 0

Statement pooling properties

The following table summarizes statement pooling connection properties.

Table 2. Statement Pooling Properties
Property Data Source Method Default
ImportStatementPool getImportStatementPool()

setImportStatementPool(String)

 No default value
MaxPooledStatements getMaxPooledStatements()

setMaxPooledStatements(Integer)

 0
RegisterStatementPoolMonitorMBean getRegisterStatementPoolMonitorMbean()

setRegisterStatementPoolMonitorMbean(Boolean)

 false

Mapping properties

The following table summarizes mapping properties.

Property Data Source Method Default
IntegerFieldMapping getIntegerFieldMapping()

setIntegerFieldMapping(String)

 Numeric
KeywordConflictSuffix getKeywordConflictSuffix()

setKeywordConflictSuffix(String)

 No default value
Schema getSchema()

setSchema(String)

 No default value

Additional properties

The following table summarizes additional connection properties.

Property Data Source Method Default
ArrowFallbackToJson

public String getArrowFallbackToJson()

public void setArrowFallbackToJson(String)

 Enable
ClientSessionKeepAlive getClientSessionKeepAlive()

setClientSessionKeepAlive(Boolean)

 false
ConnectionRetryCount getConnectionRetryCount()

setConnectionRetryCount(Integer)

 5
ConnectionRetryDelay getConnectionRetryDelay()

setConnectionRetryDelay(Integer)

 1
DisableSOCKSProxy (DSP) getDisableSocksProxy()

setDisableSocksProxy(String)

 false
FetchSize getFetchSize()

setFetchSize(Integer)

 100 (rows)
InsensitiveResultSetBufferSize getInsensitiveResultsetBufferSize()

setInsensitiveResultsetBufferSize(Integer)

 2048
LogConfigFile getLogConfigFile()

setLogConfigFile(String)

 ddlogging.properties
PartnerApplicationName getPartnerApplicationName()

setPartnerApplicationName(String)

 No default value
ReadAhead getReadAheadThreads()

setReadAheadThreads(Integer)

 5
ReadOnly getReadOnly()

setReadOnly(Boolean)

 false
Schema getSchema()

setSchema(String)

 None
SpyAttributes getSpyAttributes()

setSpyAttributes(String)

 No default value
UseSessionDatabaseForMetadata getUseSessionDatabaseForMetadata()setUseSessionDatabaseForMetadata(Boolean)

false
Warehouse getWarehouse()

setWarehouse(String)

 No default value