JDBC Driver for Teradata

Build 24.0.9060

Connection String Options

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.

Authentication


PropertyDescription
DataSourceThe Teradata server name or, equivalently, the DBC Name or TDPID.
AuthSchemeSpecifies the Logon Mechanism, which determines the connection's authentication and encryption capabilities.
UserThe Teradata user account used to authenticate.
PasswordThe password used to authenticate the user.
DatabaseThe database selected as the default database when a Teradata connection is opened.
PortConnects to the Teradata Database on the TCP/IP port specified. The default Teradata Database port is 1025.
AccountSpecifies an account string to override the default account string defined for the Teradata Database user.
BrowserSpecifies a command to override the default command to open the browser for Browser Authentication, which is chosen with the LOGMECH=BROWSER connection parameter.
BrowserTimeoutSpecifies the number of seconds that the Teradata JDBC Driver will wait for Browser Authentication to complete.
NewPasswordThis connection parameter enables an application to change an expired password automatically.

Connection


PropertyDescription
ConnectFailureTTLThis option enables the CData ADO.NET Provider for Teradata remember the time of the last connection failure for each IP address/port combination. Also, the CData ADO.NET Provider for Teradata skips connection attempts to that IP address/port during subsequent logins for the number of seconds specified by the Connect Failure time-to-live (CONNECTFAILURETTL) value.
ConnectFunctionSpecifies whether the Teradata Database should allocate a Logon Sequence Number (LSN) for this session or associate this session with an existing LSN.

Firewall


PropertyDescription
FirewallTypeThe protocol used by a proxy-based firewall.
FirewallServerThe name or IP address of a proxy-based firewall.
FirewallPortThe TCP port for a proxy-based firewall.
FirewallUserThe user name to use to authenticate with a proxy-based firewall.
FirewallPasswordA password used to authenticate to a proxy-based firewall.

Logging


PropertyDescription
LogfileA filepath which designates the name and location of the log file.
LogSpecifies the logging level (verbosity) for a connection. Logging is always enabled. The logging levels are listed in order from terse to verbose.
VerbosityThe verbosity level that determines the amount of detail included in the log file.
LogModulesCore modules to be included in the log file.
MaxLogFileSizeA string specifying the maximum size in bytes for a log file (for example, 10 MB).
MaxLogFileCountA string specifying the maximum file count of log files.

Schema


PropertyDescription
LocationA path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemasThis property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
TablesThis property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
ViewsRestricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Caching


PropertyDescription
AutoCacheAutomatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider .
CacheDriverThe database driver used to cache data.
CacheConnectionThe connection string for the cache database. This property is always used in conjunction with CacheProvider . Setting both properties will override the value set for CacheLocation for caching data.
CacheLocationSpecifies the path to the cache when caching to a file.
CacheToleranceThe tolerance for stale data in the cache specified in seconds when using AutoCache .
OfflineUse offline mode to get the data from the cache instead of the live source.
CacheMetadataThis property determines whether or not to cache the table metadata to a file store.

Miscellaneous


PropertyDescription
BatchSizeThe maximum size of each batch operation to submit.
CharsetSpecifies the session character set for encoding and decoding character data transferred to and from the Teradata Database. The default value is ASCII.
ClientCharsetSpecifies the Java character set for encoding and decoding character data transferred to and from the Teradata Database.
ColumnNameControls the behavior of the ResultSetMetaData getColumnName and getColumnLabel methods.
ConnectionLifeTimeThe maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed.
ConnectOnOpenThis property specifies whether to connect to the Teradata when the connection is opened.
CopSpecifies whether COP Discovery is performed.
CopLastSpecifies how COP Discovery determines the last COP hostname.
DdstatsSpecify the value for DDSTATS.
DisableAutoCommitInBatchSpecifies whether or not disable the autocommit when executing the batch operation.
EncryptDataSpecify the EncryptData value, ON or OFF.
ErrorQueryCountSpecifies the maximum number of times that JDBC FastLoad will attempt to query FastLoad Error Table 1 after a JDBC FastLoad operation.
ErrorQueryIntervalSpecifies the number of milliseconds that JDBC FastLoad will wait in between attempts to query FastLoad Error Table 1 after a JDBC FastLoad operation.
ErrorTable1SuffixSpecifies the suffix for the name of FastLoad Error Table 1 created by JDBC FastLoad and JDBC FastLoad CSV.
ErrorTable2SuffixSpecifies the suffix for the name of FastLoad Error Table 2 created by JDBC FastLoad and JDBC FastLoad CSV.
ErrorTableDatabaseSpecifies the database name for the FastLoad error tables created by JDBC FastLoad and JDBC FastLoad CSV.
FieldSepSpecifies a field separator for use with JDBC FastLoad CSV only. The default separator is ',' (comma).
FinalizeAutoCloseSpecify the value for FinalizeAutoClose, ON or OFF.
GeturlCredentialsSpecify the value for GeturlCredentials, ON or OFF.
GovernSpecify the value for GOVERN, ON or OFF.
HttpsPortConnects to the database on the Transmission Control Protocol/Internet Protocol (TCP/IP) port specified for HTTPS/TLS connections.
LiteralUnderscoreAutomatically escape LIKE-predicate patterns in DatabaseMetaData calls, such as schemPattern and tableNamePattern.
LobSupportSpecify the value for LobSupport, ON or OFF.
LobTempTableSpecifies the name of a table with the following columns: id integer, bval blob, cval clob.
LogDataSpecifies additional data needed by a logon mechanism, such as a secure token, Distinguished Name, or a domain/realm name.
LogonSequenceNumberSpecifies an existing Logon Sequence Number (LSN) to associate this session with.
MaxMessageBodySpecifies the maximum Response Message size in bytes.
MaxRowsLimits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
MaybeNullControls the behavior of the ResultSetMetaData.isNullable method.
OtherThese hidden properties are used only in specific use cases.
PartitionSpecifies the Teradata Database partition for the Connection.
PoolIdleTimeoutThe allowed idle time for a connection before it is closed.
PoolMaxSizeThe maximum connections in the pool.
PoolMinSizeThe minimum number of connections in the pool.
PoolWaitTimeThe max seconds to wait for an available connection.
PrepSupportSpecifies whether the Teradata Database performs a prepare operation when a PreparedStatement or CallableStatement is created.
QueryPassthroughThis option passes the query to the Teradata server as is.
ReadonlyYou can use this property to enforce read-only access to Teradata from the provider.
ReconnectCountEnables Teradata Session Reconnect. Specifies the maximum number of times that the Teradata JDBC Driver will attempt to reconnect the session.
ReconnectIntervalEnables Teradata Session Reconnect. Specifies the number of seconds that the Teradata JDBC Driver will wait in between attempts to reconnect the session.
RedriveEnables Teradata Session Reconnect, and also enables automatic redriving of SQL requests interrupted by database restart.
RTKThe runtime key used for licensing.
RunStartupSpecify the value for RunStartup, ON or OFF.
SessionsSpecifies the number of FastLoad or FastExport connections to be created, where 1 <= number of FastLoad or FastExport connections <= number of AMPs.
SipSupportControls whether the Teradata Database and Teradata JDBC Driver use StatementInfo Parcel (SIP) to convey metadata.
SlobReceiveThresholdControls how small LOB values are received from the Teradata Database. Small LOB values are pre-fetched from the Teradata Database before the application explicitly reads data from Blob/Clob objects.
SlobTransmitThresholdControls how small LOB values are transmitted to the Teradata Database.
SpSplSpecifies behavior for creating or replacing Teradata stored procedures.
SslCaSpecifies the file name of a PEM file that contains Certificate Authority (CA) certificates for use with SSLMODE=VERIFY-CA or VERIFY-FULL.
SslCaPathSpecifies a directory of PEM files that contain Certificate Authority (CA) certificates for use with SSLMODE=VERIFY-CA or VERIFY-FULL.
SslModeSpecifies the mode for connections to the database.
SslProtocolSpecifies the TLS protocol for HTTPS/TLS connections.
StrictEncodeSpecifies behavior for encoding character data to transmit to the Teradata Database.
TcpSpecifies one or more TCP socket settings, separated by plus signs ("+").
TimeoutThe value in seconds until the timeout error is thrown, canceling the operation.
TModeSpecifies the transaction mode for the connection.
TNanoSpecifies the fractional seconds precision for all java.sql.Time values bound to a PreparedStatement or CallableStatement and transmitted to the Teradata Database as TIME or TIME WITH TIME ZONE values.
TrustedSqlSpecify the value for TrustedSql.
TSNanoSpecifies the fractional seconds precision for all java.sql.Timestamp values bound to a PreparedStatement or CallableStatement and transmitted to the Teradata Database as TIMESTAMP or TIMESTAMP WITH TIME ZONE values.
TypeSpecifies the type of protocol to be used with the Teradata Database for SQL statements.
UpperCaseIdentifiersThis property reports all identifiers in uppercase. This is the default for Oracle databases and thus allows better integration with Oracle tools such as the Oracle Database Gateway.
UseConnectionPoolingThis property enables connection pooling.
UseXViewsSpecifies which Data Dictionary views should be queried to return result sets from DatabaseMetaData methods.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060