17.20 - ODBC Driver Setup Parameters - ODBC Driver for Teradata

ODBC Driver for Teradata® User Guide

ODBC Driver for Teradata
Release Number
June 2022
English (United States)
Last Update
Field, Check Box, or Button Description
Data Source
Name Enter the Data Source Name (DSN) that the application is to refer to when executing SQLConnect or SQLDriverConnect. The entered DSN is the name that will appear in the Data Sources dialog box during a manual connection.

See the “data-source-name=<driver>” option in ODBC Data Sources Section.

Description [Optional] Enter descriptive text about the data source in this box.

This is a comment field that is not retrievable by an SQL or ODBC command.

See the “Description=<data-source-desc>” option in Data Source Specification Section.

Teradata Server Info
Name or IP address Perform one of the following:
  • Enter the database system name (alias or FQDN) without COP suffix.
  • Enter the name or IP address of the LAN-connected node in your system, one per line.

After providing the name, ODBC Driver for Teradata dynamically detects all associated COP entries.

You must define COP names or the name without COP suffix in either a Domain Name Services (DNS) or the local hosts file. For more information, see Cop Discovery.

Use Integrated Security Default = Cleared

Clear this check box to enable the user to connect to the database using Conventional Sign On (CSO).

Select this check box to enable the user to connect to the database using Single Sign-On (SSO).

In CSO from a network client, the user must provide a database username and password. These are sent to the database for validation. If the username exists and the password correctly matches, access is allowed. Otherwise, the connection request is rejected.

In SSO, the username and password are not submitted. The database username is derived from the user identity on the client platform.

Test The Data Source Name, Name or IP Address, and Username must be specified to test the connection.

Click Test, enter the Authentication Parameter or Password, and click OK to test the connection.

If the DSN entry does not have enough information to make the connection, Connection Dialog appears. See Completing Connection Information for more information.

Enter the password required for the default Username.

Passwords stored locally (Windows registry), even in encrypted form, is not 100% secure, so this feature has been removed in ODBC Driver for Teradata 17.00.

For more information, see Security Considerations.

Instead of storing the actual password in DSN, Teradata recommends using a Teradata Wallet reference string as a password. Password and Teradata Wallet String fields are mutually exclusive, so a DSN can have either the Password or a Teradata Wallet String.

For more information, see Teradata Wallet.

Mechanism Default = determined by a configuration option set in an XML file by TeraGSS program, tdgssconfigure.
Specify the desired security checking mechanism. Valid values are:
  • Empty – the same as omitting the keyword
  • TD2 – selects Teradata 2 as the authentication mechanism. Username and password are required.
  • TDNEGO – selects one of the Authentication Mechanisms automatically based on the policy, without user involvement.
  • LDAP – selects Lightweight Directory Access Protocol (LDAP) as the Authentication Mechanism. The application provides the username and password.
  • KRB5 – selects Kerberos (KRB5) on Windows clients working with Windows servers. The application provides the username and password.
  • JWT – selects JSON Web Token (JWT) as the Authentication Mechanism. An authentication mechanism based on the JWT needs to be provided in the form of "token=<JWT token>" where <JWT token> is the actual JWT token.
  • EXTERNALBROWSER – Selects CloudSSO on Windows and Apple MacOS as the Authentication Mechanism. The users’ identity is obtained through Keycloak or PingFederate login using an external browser. The user is logged on without providing a username and password.

See complete descriptions at Authentication Mechanisms.

Parameter Wallet String

Indicate a string of characters to be regarded as a parameter of the authentication mechanism. The string is transparent to ODBC Driver for Teradata and is passed to the Teradata authentication software called to set the mechanism.

Enclose characters [] {} () , ; ? * = ! @ in braces.

The value may be enclosed by $tdwallet(), for example, $tdwallet(WalletRefString). If it is not, the driver will automatically enclose it when the value is saved.

For more information, see Teradata Wallet.

Username Default = Cleared

Specify a username for the default database.

Shows the default username that was specified during the data sources configuration of the driver. The default value can be overridden here. If required, the user is prompted for additional information. The username and password are Teradata-specific, not to be confused with Windows user ids and passwords.

The username is interpreted in the context of the authentication mechanism. If, for example, the authentication mechanism is NTLM, then the username is assumed to be a Windows username.

If the authentication mechanism allows fully qualified usernames, then the username can contain a domain or realm; for example, {judy@linedata}. Values containing a character such as @ must be enclosed in braces.

SSO is indicated by the absence of a Username and Password.

See the “Username=<name>” option in Data Source Specification Section.

Password Wallet String
Starting with ODBC Driver for Teradata 17.00, passwords can no longer be saved using the user interface. Teradata recommends using Teradata Wallet to store password information.

The value may be enclosed by $tdwallet(), for example, $tdwallet(WalletRefString). If it is not, the driver will automatically enclose it when the value is saved.

For more information, see Teradata Wallet.

Default Database Default = Cleared

Specify a default database.

See the “DefaultDatabase=<database-name>” option in Data Source Specification Section.

Account String Default = Cleared

Enter a user in the database while configuring the data source rather than having to provide account information during configuration of ODBC Driver for Teradata.

This information can be used to help isolate users, to find out what application the users are running, or to restrict users from logging on.

See the “AccountStr=<account>” option in Teradata DSN Options.

Session Character Set Default = ASCII

Specify the character set for the session. It is strongly recommended to use the default ASCII session only for 7-bit ASCII characters. UTF8 is the recommended default session character set for all languages including US English. To use a different character set than is chosen by default, specify or select it here.

The options available from the drop-down list are:
  • UTF8
  • UTF16
  • LATIN1252_0A
  • SCHINESE936_6R0
  • TCHINESE950_8R0
  • LATIN9_0A
  • LATIN1_0A
  • Shift-JIS (Windows, DOS compatible, KANJISJIS_0S)
  • EUC (Unix compatible, KANJIEC_0U)
  • IBM Mainframe (KANJIEBCDIC5035_0I)
  • BIG5 (TCHBIG5_1R0)
  • GB (SCHGB2312_1T0)
  • NetworkKorean (HANGULKSC5601_2R4)
  • Latin1252_3A0
  • KANJI932_1S0
  • HANGUL949_7R0
  • ARABIC1256_6A0
  • CYRILLIC1251_2A0
  • HEBREW1255_5A0
  • LATIN1250_1A0
  • LATIN1254_7A0
  • LATIN1258_8A0
  • THAI874_4A0
See the note in Session Character Sets and Translation DLLs for more information on restrictions.
For user-defined session character sets that are not shown on the above list, type the name of the user-defined session character set.