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.
Property | Description |
DataSource | The Teradata server name or, equivalently, the DBC Name or TDPID. |
AuthScheme | Specifies the Logon Mechanism, which determines the connection's authentication and encryption capabilities. |
User | The Teradata user account used to authenticate. |
Password | The password used to authenticate the user. |
Database | The database selected as the default database when a Teradata connection is opened. |
Port | Connects to the Teradata Database on the TCP/IP port specified. The default Teradata Database port is 1025. |
Account | Specifies an account string to override the default account string defined for the Teradata Database user. |
Browser | Specifies a command to override the default command to open the browser for Browser Authentication, which is chosen with the LOGMECH=BROWSER connection parameter. |
BrowserTimeout | Specifies the number of seconds that the Teradata JDBC Driver will wait for Browser Authentication to complete. |
NewPassword | This connection parameter enables an application to change an expired password automatically. |
Property | Description |
ConnectFailureTTL | This 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. |
ConnectFunction | Specifies whether the Teradata Database should allocate a Logon Sequence Number (LSN) for this session or associate this session with an existing LSN. |
Property | Description |
FirewallType | The protocol used by a proxy-based firewall. |
FirewallServer | The name or IP address of a proxy-based firewall. |
FirewallPort | The TCP port for a proxy-based firewall. |
FirewallUser | The user name to use to authenticate with a proxy-based firewall. |
FirewallPassword | A password used to authenticate to a proxy-based firewall. |
Property | Description |
Logfile | A filepath which designates the name and location of the log file. |
Log | Specifies the logging level (verbosity) for a connection. Logging is always enabled. The logging levels are listed in order from terse to verbose. |
Verbosity | The verbosity level that determines the amount of detail included in the log file. |
LogModules | Core modules to be included in the log file. |
MaxLogFileSize | A string specifying the maximum size in bytes for a log file (for example, 10 MB). |
MaxLogFileCount | A string specifying the maximum file count of log files. |
Property | Description |
Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC. |
Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC. |
Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC. |
Property | Description |
AutoCache | Automatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider . |
CacheDriver | The database driver used to cache data. |
CacheConnection | The 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. |
CacheLocation | Specifies the path to the cache when caching to a file. |
CacheTolerance | The tolerance for stale data in the cache specified in seconds when using AutoCache . |
Offline | Use offline mode to get the data from the cache instead of the live source. |
CacheMetadata | This property determines whether or not to cache the table metadata to a file store. |
Property | Description |
BatchSize | The maximum size of each batch operation to submit. |
Charset | Specifies the session character set for encoding and decoding character data transferred to and from the Teradata Database. The default value is ASCII. |
ClientCharset | Specifies the Java character set for encoding and decoding character data transferred to and from the Teradata Database. |
ColumnName | Controls the behavior of the ResultSetMetaData getColumnName and getColumnLabel methods. |
ConnectionLifeTime | The maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed. |
ConnectOnOpen | This property specifies whether to connect to the Teradata when the connection is opened. |
Cop | Specifies whether COP Discovery is performed. |
CopLast | Specifies how COP Discovery determines the last COP hostname. |
Ddstats | Specify the value for DDSTATS. |
DisableAutoCommitInBatch | Specifies whether or not disable the autocommit when executing the batch operation. |
EncryptData | Specify the EncryptData value, ON or OFF. |
ErrorQueryCount | Specifies the maximum number of times that JDBC FastLoad will attempt to query FastLoad Error Table 1 after a JDBC FastLoad operation. |
ErrorQueryInterval | Specifies the number of milliseconds that JDBC FastLoad will wait in between attempts to query FastLoad Error Table 1 after a JDBC FastLoad operation. |
ErrorTable1Suffix | Specifies the suffix for the name of FastLoad Error Table 1 created by JDBC FastLoad and JDBC FastLoad CSV. |
ErrorTable2Suffix | Specifies the suffix for the name of FastLoad Error Table 2 created by JDBC FastLoad and JDBC FastLoad CSV. |
ErrorTableDatabase | Specifies the database name for the FastLoad error tables created by JDBC FastLoad and JDBC FastLoad CSV. |
FieldSep | Specifies a field separator for use with JDBC FastLoad CSV only. The default separator is ',' (comma). |
FinalizeAutoClose | Specify the value for FinalizeAutoClose, ON or OFF. |
GeturlCredentials | Specify the value for GeturlCredentials, ON or OFF. |
Govern | Specify the value for GOVERN, ON or OFF. |
HttpsPort | Connects to the database on the Transmission Control Protocol/Internet Protocol (TCP/IP) port specified for HTTPS/TLS connections. |
LiteralUnderscore | Automatically escape LIKE-predicate patterns in DatabaseMetaData calls, such as schemPattern and tableNamePattern. |
LobSupport | Specify the value for LobSupport, ON or OFF. |
LobTempTable | Specifies the name of a table with the following columns: id integer, bval blob, cval clob. |
LogData | Specifies additional data needed by a logon mechanism, such as a secure token, Distinguished Name, or a domain/realm name. |
LogonSequenceNumber | Specifies an existing Logon Sequence Number (LSN) to associate this session with. |
MaxMessageBody | Specifies the maximum Response Message size in bytes. |
MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
MaybeNull | Controls the behavior of the ResultSetMetaData.isNullable method. |
Other | These hidden properties are used only in specific use cases. |
Partition | Specifies the Teradata Database partition for the Connection. |
PoolIdleTimeout | The allowed idle time for a connection before it is closed. |
PoolMaxSize | The maximum connections in the pool. |
PoolMinSize | The minimum number of connections in the pool. |
PoolWaitTime | The max seconds to wait for an available connection. |
PrepSupport | Specifies whether the Teradata Database performs a prepare operation when a PreparedStatement or CallableStatement is created. |
QueryPassthrough | This option passes the query to the Teradata server as is. |
Readonly | You can use this property to enforce read-only access to Teradata from the provider. |
ReconnectCount | Enables Teradata Session Reconnect. Specifies the maximum number of times that the Teradata JDBC Driver will attempt to reconnect the session. |
ReconnectInterval | Enables Teradata Session Reconnect. Specifies the number of seconds that the Teradata JDBC Driver will wait in between attempts to reconnect the session. |
Redrive | Enables Teradata Session Reconnect, and also enables automatic redriving of SQL requests interrupted by database restart. |
RTK | The runtime key used for licensing. |
RunStartup | Specify the value for RunStartup, ON or OFF. |
Sessions | Specifies the number of FastLoad or FastExport connections to be created, where 1 <= number of FastLoad or FastExport connections <= number of AMPs. |
SipSupport | Controls whether the Teradata Database and Teradata JDBC Driver use StatementInfo Parcel (SIP) to convey metadata. |
SlobReceiveThreshold | Controls 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. |
SlobTransmitThreshold | Controls how small LOB values are transmitted to the Teradata Database. |
SpSpl | Specifies behavior for creating or replacing Teradata stored procedures. |
SslCa | Specifies the file name of a PEM file that contains Certificate Authority (CA) certificates for use with SSLMODE=VERIFY-CA or VERIFY-FULL. |
SslCaPath | Specifies a directory of PEM files that contain Certificate Authority (CA) certificates for use with SSLMODE=VERIFY-CA or VERIFY-FULL. |
SslMode | Specifies the mode for connections to the database. |
SslProtocol | Specifies the TLS protocol for HTTPS/TLS connections. |
StrictEncode | Specifies behavior for encoding character data to transmit to the Teradata Database. |
Tcp | Specifies one or more TCP socket settings, separated by plus signs ("+"). |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
TMode | Specifies the transaction mode for the connection. |
TNano | Specifies 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. |
TrustedSql | Specify the value for TrustedSql. |
TSNano | Specifies 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. |
Type | Specifies the type of protocol to be used with the Teradata Database for SQL statements. |
UpperCaseIdentifiers | This 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. |
UseConnectionPooling | This property enables connection pooling. |
UseXViews | Specifies which Data Dictionary views should be queried to return result sets from DatabaseMetaData methods. |