Client Interfaces Guide > Connecting to TDV Server through JDBC > Defining a JDBC Client using a Connection URL > JDBC Driver Connection URL Properties
 
JDBC Driver Connection URL Properties
This table lists the names of properties that you can specify in the JDBC connection URL.
Non-alphanumeric characters within a NAME or VALUE must be URL-encoded.
JDBC Property Name
Description
alternatesecuritycredentials
Specifies an alternate security property value to the identity within the current session. This is used to allow the user passing security property to the data source.
Note: You may get unexpected results when multiple requests are made on the same session or when multiple identities access the same session.
caseSensitive
Specifies case sensitivity in the request values. By default (false), requests are not case-sensitive.
commitFailure
Behavior if commit failed, possible values: rollback or bestEffort.
commitInterrupt
Specifies the behavior if a commit is interrupted, possible values are: ignore, log, fail.
compensate
If enabled, compensation blocks will be run if the transaction rolls back. Possible values: disabled or enabled. Default value is disabled.
connectTimeout
Time-out for initial connection, in seconds. Use 0 (zero) for infinite time-out.
convertToLocalTimezone
When set to the default value (false), the client receives TIMESTAMP values directly from the published data source, without conversion to the client’s local time zone. If the value from the data source had a time zone associated with a TIMESTAMP, that value is preserved.
When set to true, TIMESTAMP values are converted to the client’s time zone (as in some earlier releases of TDV).
disableClustering
When set to the default value (false), enables data views from system tables from individual TDV instances in a cluster.
enableTDVConnectionPool
By default the value of this property is set to false. If set to true, the driver will revert to previous behavior where the connections to TDV server are pooled.
enableTDVTimestamp
Set this property in the JDBC driver to get the correct hour value, regardless of the current time zone or DST setting on the host server. When this property is enabled:
ResultSet.getObject() returns a custom child class of java.sql.Timestamp, with unchanged timestamp.
ResultSet.getTime() returns a java.sql.Time object with unchanged time (hour, minute, second), but the time from epoch is changed.
ResultSet.getString() returns the unchanged timestamp text.
ResultSet.getTimestamp() returns java.sql.Timestamp with changed timestamp regardless of the value of this property.
Notes:
1) This JDBC property is required only if current time setting enables the clock to automatically adjust for daylight saving time (DST), and timestamp in database is a DST transition time (for example, from 2010-03-14 02:00:00 to 2010-03-14 02:59:59).
2) This JDBC property only affects getObject(), getTime(), and getString() of class ResultSet.
enableFastExec
Values are true or false, and the default value is false.
Results are processed and returned immediately (instead of a round trip) when a query is submitted, potentially improving performance of low latency queries.
enableFlood
Values are true or false. Default value is true.
If true, the server will constantly send data, filling the network buffer.Useful for larger result sets.
enableReconnectOnError
Specifies cluster reconnection behavior.
encrypt
When set to true, automatically passes JDBC messages to the SSL port for processing with the TDV SSL Certificate. See “Web Services Security” in the TDV User Guide.
fetchBytes
Maximum number of rows to fetch for a batch based on batch size, in bytes. Setting fetchBytes to a very large number can cause an Out Of Memory error in the server. The value set for fetchBytes affects the memory used on the JDBC client and the TDV server, so the value should be set based on the heap size configured.
fetchRows
Maximum number of rows to fetch for a batch. Set to zero to return an unlimited number of rows.
ignoreTrailingSpace
Ignore trailing spaces at the end of values. Default: false.
kerberos.krb5.conf
Path to krb5.conf file.
locale
Value that defines the user’s language and country.
nometadata
Blocks return of result-set metadata during query execution.
paramMode
Controls the behavior of OUT parameters for stored procedures:
normal—Report OUT parameters in procedure metadata as OUT parameters.
return—Report OUT parameters as return values.
omit—Omit OUT parameters from metadata.
omitCursors—Omit output cursors from metadata.
pingInterval
Maximum time to wait before sending a ping request while waiting for result from TDV, in seconds.
pingTimeoutWindow
The length of time the JDBC or ODBC client waits before closing a connection to the TDV server, after a ping to the TDV server has failed.
The value of this parameter should be greater than or equal to the "PingInterval" parameter. If a ping sent to the TDV server fails, the ODBC or JDBC client continues to send pings to TDV to check status. If these client pings continue to fail after the TimeoutWindow has expired, the ODBC or JDBC client closes the connection to the TDV server and sends a message. While the TimeoutWindow has not expired, the ODBC or JDBC client connection stays open and continues to send pings to the TDV server waiting for a response. The default for this property is "0", which means the setting is not being used. If not set, the session timeout and or request timeout is used instead.
registerOutputCursors
true—Bind or register output cursors as output parameters.
false—Do not bind or register output cursors as output parameters; instead, use SQLMoreResults or Statement.getMoreResults() to access the cursors. See Example of Calling Procedures.
requestTimeout
Time-out for query commands and other requests.
sessionTimeout
Session inactivity time-out, in seconds. Set to zero for infinite time-out.
sessionToken
Uses the JDBC URL to set a session token value for client authorization when using TDV with a client restricted license.
Example: &sessionToken=<VALUE>
singleLogSize
Maximum log file size to saving to next log file, in M bytes.
stripDuplicates
Values are true or false. Default value is false.
If true, the server will detect for duplicate CHAR/VARCHAR columns in subsequent rows, and will not re-transmit the data across the wire.
This would potentially lead to data savings across the wire.
stripTrailingZeros
Determines whether decimal result values are to be returned with trailing zeros removed.
traceLevel
Valid values are off, fatal, error (this is the default), debug, warn, info, debug, and all.
The valid values for client-side log settings are off, fatal, error (default), warn, info, debug, all, stdout.
On UNIX-based platforms, the log file CsOdbcDebug.log is created in the directory specified by the environment variable COMPOSITE_HOME.
unsupportedMode
Valid values are silent, warn, or fail. The default value is fail.
When set to silent, unsupported methods do nothing and return. When set to warn, the JDBC driver logs a warning message in the log file, Otherwise, the JDBC driver returns a SQL_ERROR when it encounters unsupported methods. See Unsupported JDBC Methods.
user_tokens
Authentication values that can be packaged for delivery. The URL can pass the user_tokens property to the server at the init command, in the form:
"user_tokens=(" NAME "=" VALUE ( "," NAME "=" VALUE )* ")"
validateRemoteCert
Windows platform only. Ignored on UNIX platforms.
False (default): no certificate validation is performed before establishing a connection. Also by default, a placeholder certificate is installed; csjdbc.jar uses a default bundled truststore for validation, unless the client system truststore is present and configured.
True: The TDV JDBC client initiates the validation handshake, using the TDV certificate a for password encryption. If validation fails, no connection is established.
The TDV Server certificate is loaded from the file specified in the Truststore File Location configuration parameter.
The Keystore Key Alias is used when it is configured.
The TDV JDBC client driver uses the client system’s truststore properties to validate the certificate:
javax.net.ssl.trustStore
javax.net.ssl.trustStorePassword
javax.net.ssl.trustStoreType
The TDV Server certificate must be added to this client’s truststore; otherwise, validation fails.
The placeholder TDV certificate does not work after the client system truststore is enabled, unless it is added to the client truststore.
validateRemoteHostname
Windows platform only. Ignored on UNIX platforms.
False (default): No host name validation is performed.
True: The csjdbc.jar compares the value of host in JDBC URL with the subject CN (common name) value in the certificate received from the targeted TDV Server.
If host name validation fails, the connection is not established.