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 connection properties required to connect to a database.

Property Data Source Method Default
PortNumber setPortNumber

getPortNumber

 5432
ServerName setServerName

getServerName

 No default value
DatabaseName setDatabaseName

getDatabaseName

 No default value

User ID/password authentication properties

The following table summarizes the connection properties required for user ID/password authentication.

Property Data Source Method Default
AuthenticationMethod setAuthenticationMethod

getAuthenticationMethod

 userIdPassword
User setUser

getUser

 No default value
Password setPassword

getPassword

 No default value

Kerberos authentication properties

The following table summarizes the connection properties required for Kerberos authentication.

Property Data Source Method Default
AuthenticationMethod setAuthenticationMethod

getAuthenticationMethod

 userIdPassword
DatabaseName setDatabaseName

getDatabaseName

 No default value
ServicePrincipalName setServicePrincipalName

getServicePrincipalName

 No default value
LoginConfigName setLoginConfigName

getLoginConfigName

 JDBC_DRIVER_01

Entra ID user and password authentication properties

The following table summarizes the connection properties required for Entra ID user and password authentication.

Property Data Source Method Default
AuthenticationMethod setAuthenticationMethod

getAuthenticationMethod

 userIdPassword
User setUser

getUser

 No default value
Password setPassword

getPassword

 No default value
AzureTenantID getAzureTenantID

setAzureTenantID

 No default value

Entra ID service principal authentication properties

The following table summarizes the connection properties required for Entra ID service principal authentication.

Property Data Source Method Default
AuthenticationMethod setAuthenticationMethod

getAuthenticationMethod

 userIdPassword
User setUser

getUser

 No default value
Password setPassword

getPassword

 No default value
AzureTenantID public String getAzureTenantID

setAzureTenantID

 No default value

AWS IAM authentication properties

The following table summarizes the connection properties required for AWS IAM authentication.

Property Data Source Method Default
AuthenticationMethod setAuthenticationMethod

getAuthenticationMethod

 userIdPassword
AccessKey

getAccessKey()

setAccessKey(String)

 No default value
Region

getRegionName()

setRegionName(String)

 No default value
SecretKey

getSecretKey()

setSecretKey(String)

 No default value
TrustStore setTrustStore

getTrustStore

 No default value
TrustStorePassword setTrustStorePassword

getTrustStorePassword

 No default value

Proxy server properties

The following table summarizes proxy server connection properties.

Property Data Source Method Default
ProxyHost getProxyHost

setProxyHost

 No default value
ProxyPassword getProxyPassword

setProxyPassword

 No default value
ProxyPort getProxyPort

setProxyPort

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

For HTTP URLs: 80

For HTTPS URLs: 443
ProxyUser getProxyUser

setProxyUser

 No default value

Data encryption properties

The following table summarizes connection properties that can be used to enable SSL.

Property Data Source Method Default
CryptoProtocolVersion setCryptoProtocolVersion

getCryptoProtocolVersion

 No default value
EncryptionMethod setEncryptionMethod

getEncryptionMethod

 noEncryption
HostNameInCertificate setHostNameInCertificate

getHostNameInCertificate

 No default value
KeyStore setKeyStore

getKeyStore

 No default value
KeyStorePassword setKeyStorePassword

getKeyStorePassword

 No default value
KeyPassword setKeyPassword

getKeyPassword

 No default value
TrustStore setTrustStore

getTrustStore

 No default value
TrustStorePassword setTrustStorePassword

getTrustStorePassword

 No default value
ValidateServerCertificate setValidateServerCertificate

getValidateServerCertificate

 true

Bulk load properties

The following table contains the only connection property that affects how bulk load works with the driver.

Property Data Source Method Default
BulkLoadBatchSize setBulkLoadBatchSize

getBulkLoadBatchSize

 1000

Failover properties

The following table summarizes the connection properties used for configuring failover.

Property Data Source Method Default
AlternateServers setAlternateServers

getAlternateServers

 No default value
ConnectionRetryCount setConnectionRetryCount

getConnectionRetryCount

 5
ConnectionRetryDelay setConnectionRetryDelay

getConnectionRetryDelay

 1 (second)
DatabaseName setDatabaseName

getDatabaseName

 No default value
LoadBalancing setLoadBalancing

getLoadBalancing

 false

Timeout properties

The following table summarizes timeout connection properties.

Property Data Source Method Default
EnableCancelTimeout setEnableCancelTimeout

getEnableCancelTimeout

 false
LoginTimeout setLoginTimeout

getLoginTimeout

 0
QueryTimeout setQueryTimeout

getQueryTimeout

 0

Client information properties

The following table summarizes connection properties that can be used to return client information.

Property Data Source Method Default
AccountingInfo setAccountingInfo

getAccountingInfo

 No default value
ApplicationName setApplicationName

getApplicationName

 No default value
ClientHostName setClientHostName

getClientHostName

 No default value
ClientUser setClientUser

getClientUser

 No default value
ProgramID setProgramID

getProgramID

 No default value

Statement pooling properties

The following table summarizes statement pooling connection properties.

Property Data Source Method Default
ImportStatementPool setImportStatementPool

getImportStatementPool

 No default value
MaxPooledStatements setMaxPooledStatements

getMaxPooledStatements

 0
RegisterStatementPoolMonitorMBean setRegisterStatementPoolMonitorMBean

getRegisterStatementPoolMonitorMBean

 false

Additional properties

The following table summarizes additional connection properties.

Property Data Source Method Default
BatchMechanism setBatchMechanism

getBatchMechanism

 nativeBatch
CallEscapeBehavior setCallEscapeBehavior

getCallEscapeBehavior

 callIfNoReturn
CodePageOverride setCodePageOverride

getCodePageOverride

 No default value
CatalogOptions setCatalogOptions

getCatalogOptions

 2
ConvertNull setConvertNull

getConvertNull

 1
EnablePrepareThreshold setEnablePrepareThreshold

getEnablePrepareThreshold

 false
ExtendedColumnMetadata setExtendedColumnMetadata

getExtendedColumnMetadata

 false
InitializationString setInitializationString

getInitializationString

 No default value
InsensitiveResultSetBufferSize setInsensitiveResultSetBufferSize

getInsensitiveResultSetBufferSize

 2048
JavaDoubleToString setJavaDoubleToString

getJavaDoubleToString

 false
MaxLongVarcharSize setMaxLongVarcharSize

getMaxLongVarcharSize

 1,073,741,823
MaxNumericPrecision setMaxNumericPrecision

getMaxNumericPrecision

 1000
MaxNumericScale setMaxNumericScale

getMaxNumericScale

 998
MaxStatements setMaxStatements

getMaxStatements

 0
MaxVarcharSize setMaxVarcharSize

getMaxVarcharSize

 10,485,760
PrepareThreshold setPrepareThreshold

getPrepareThreshold

 1
ResultSetMetaDataOptions setResultSetMetaDataOptions

getResultSetMetaDataOptions

 0
SpyAttributes setSpyAttributes

getSpyAttributes

 No default value
SupportsCatalogs setSupportsCatalogs

getSupportsCatalogs

 true
TransactionErrorBehavior setTransactionErrorBehavior

getTransactionErrorBehavior

 RollbackTransaction
VarcharClobThreshold setVarcharClobThreshold

getVarcharClobThreshold

 32768