Connection Property Descriptions
- Last Updated: August 23, 2024
- 1 minute read
- DataDirect Connectors
- JDBC
- Apache Spark SQL 6.0
- Documentation
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 Driver
Manager or a JDBC data source. For a Driver Manager 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).
- 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,
Passwordis the same aspassword. - 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 }orPassword={{hello}}.
The following table provides a summary of the connection properties supported by the driver and their default values.
| Property | Data Source Method | Default |
|---|---|---|
| AccountingInfo | setAccountingInfo | empty string |
| ApplicationName | setApplicationName | empty string |
| ArrayFetchSize | setArrayFetchSize | 20000
(cells) |
| AuthenticationMethod | setAuthenticationMethod | userIdPassword |
| BinaryDescribeType | setBinaryDescribeType |
varbinary |
| ClientHostName | setClientHostName | empty string |
| ClientUser | setClientUser | empty string |
| ConnectionRetryCount | setConnectionRetryCount | 5 |
| ConnectionRetryDelay | setConnectionRetryDelay | 1
(second) |
| ConvertNull | setConvertNull | 1 |
| CookieName | setCookieName | hive.server2.auth |
| CryptoProtocolVersion | setCryptoProtocolVersion | None |
| DatabaseName | setDatabaseName | The default database |
| EnableCookieAuthentication | setEnableCookieAuthentication |
true
|
| EncryptionMethod | setEncryptionMethod | noEncryption |
| HostNameInCertificate | setHostNameInCertificate | empty string |
| HTTPPath | setHTTPPath | cliservice |
| ImportStatementPool | setImportStatementPool | empty string |
| InitializationString | setInitializationString | None |
| InsensitiveResultSetBufferSize | setInsensitiveResultSetBufferSize |
2048
|
| JavaDoubleToString | setJavaDoubleToString |
false
|
| KeyPassword | setKeyPassword | None |
| KeyStore | setKeyStore | None |
| KeyStorePassword | setKeyStorePassword | None |
| LoginTimeout | setLoginTimeout |
0
|
| MaxBinarySize | setMaxBinarySize | 2147483647 |
| MaxPooledStatements | setMaxPooledStatements | None |
| Password | setPassword | None |
| PortNumber | setPortNumber | 10000 |
| ProgramID | setProgramID | empty string |
| ProxyHost | setProxyHost | empty string |
| ProxyPassword | setProxyPassword | empty string |
| ProxyPort | setProxyPort | 0 |
| ProxyUser | setProxyUser | empty string |
| RegisterStatementPoolMonitorMBean | setRegisterStatementPoolMonitorMBean | false |
| RemoveColumnQualifiers | setRemoveColumnQualifiers | false |
| ServerName | setServerName | None |
| ServicePrincipalName | setServicePrincipalName | None |
| SpyAttributes | setSpyAttributes | None |
| StringDescribeType | setStringDescribeType |
varchar
|
| TransactionMode | setTransactionMode |
noTransactions
|
| TransportMode | setTransportMode |
binary
|
| TrustStore | setTrustStore | None |
| TrustStorePassword | setTrustStorePassword | None |
| UseCurrentSchema | setUseCurrentSchema | false (results are not restricted to the tables and
views in the current schema) |
| User | setUser | None |
| UserAgent |
setUserAgent |
No default value, which means the driver uses Progress/8.0 (SparkSQL ODBC driver) for the value of the User-Agent header. |
| ValidateServerCertificate | setValidateServerCertificate | true |