Tableau Connector for Teradata

Build 24.0.9175

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.
UserSpecifies the user ID of the authenticating Teradata user account.
PasswordSpecifies the password of the authenticating user account.
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
FirewallTypeSpecifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServerIdentifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPortSpecifies the TCP port to be used for a proxy-based firewall.
FirewallUserIdentifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPasswordSpecifies the password of the user account authenticating to a proxy-based firewall.

Logging


PropertyDescription
LogfileSpecifes the file path to the log file where the provider records its activities, such as authentication, query execution, and connection details.
LogSpecifies the logging level (verbosity) for a connection. Logging is always enabled. The logging levels are listed in order from terse to verbose.
VerbositySpecifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.
LogModulesSpecifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.
MaxLogFileSizeSpecifies the maximum size of a single log file in bytes. For example, '10 MB'. When the file reaches the limit, the provider creates a new log file with the date and time appended to the name.
MaxLogFileCountSpecifies the maximum number of log files the provider retains. When the limit is reached, the oldest log file is deleted to make space for a new one.

Schema


PropertyDescription
LocationSpecifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
BrowsableSchemasOptional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
TablesOptional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
ViewsOptional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Caching


PropertyDescription
AutoCacheSpecifies whether the content of tables targeted by SELECT queries is automatically cached to the specified cache database.
CacheDriverThe driver class of a JDBC driver. The specified driver is used to connect to the target database for all caching operations.
CacheConnectionThe connection string for the specified cache database.
CacheLocationSpecifies the path to the cache when caching to a file.
CacheToleranceThe tolerance, in seconds, for stale data in the specified cache database.
OfflineGet the data from the specified cache database instead of live Teradata data.
CacheMetadataDetermines whether the provider caches table metadata to a file-based cache database.

Miscellaneous


PropertyDescription
BatchSizeSpecifies the maximum number of rows included in each batch operation. Set to 0 to submit the entire batch as a single request.
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.
ConnectionLifeTimeSpecifies the maximum lifetime of a connection in seconds. When the specified time elapses, the provider closes the connection. Set to 0 or leave empty for no time limit.
ConnectOnOpenSpecifies whether the provider establishes a connection to Teradata immediately upon opening the connection. The default value is false. Enable this property only if immediate connectivity verification is necessary.
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.
MaxRowsSpecifies the maximum rows returned for queries without aggregation or GROUP BY.
MaybeNullControls the behavior of the ResultSetMetaData.isNullable method.
OtherSpecifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
PartitionSpecifies the Teradata Database partition for the Connection.
PoolIdleTimeoutSpecifies the maximum idle time, in seconds, that a connection can remain in the pool before being closed.
PoolMaxSizeSpecifies the maximum number of connections allowed in the connection pool. The default value is 100. Set to 0 or a negative value to disable pooling.
PoolMinSizeSpecifies the minimum number of connections maintained in the connection pool. The default value is 1.
PoolWaitTimeSpecifies the maximum number of seconds a connection request waits for an available connection in the pool. If the wait exceeds this time, an error is returned. The default is 60 seconds.
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.
ReadonlyToggles 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.
RTKSpecifies the runtime key for licensing the provider. If unset or invalid, the provider defaults to the standard licensing method. Use this property only in environments where the standard licensing method is unsupported or requires a runtime key.
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 ("+").
TimeoutSpecifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
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.
UseConnectionPoolingEnables the connection pooling feature, which allows the provider to reuse existing connections instead of creating new ones for each request.
UseXViewsSpecifies which Data Dictionary views should be queried to return result sets from DatabaseMetaData methods.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 24.0.9175