Configuring a DSN Using ODBC Administrator Tool - ODBC Driver for Teradata

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

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.

• Enter the Teradata Database 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.

See complete descriptions at Authentication Mechanisms.

Once a parameter is entered, the text will be masked with * characters.

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

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

You can use a Teradata Wallet reference string instead of a plain text parameter by specifying the $tdwallet() token. For example:

$tdwallet(WalletRefString)

For more information, see Teradata Wallet.

Specify a username for the default Teradata Database.

Shows the default username that was specified during the data source(s) 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 other user ids and passwords.

The username is interpreted in the context of the authentication mechanism.

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.

For more information, see Teradata Wallet.

Specify a default database.

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

Enter a user in Teradata 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 “AccountString=<account>” option in Teradata DSN Options.

Specify the character set for the session. To use a different character set than is chosen by default, specify or select it here.

Determines whether ODBC Driver for Teradata returns column names or column titles.

See the “DontUseTitles=[Yes|No]” option in Teradata DSN Options.

Determines whether ODBC Driver for Teradata operates in synchronous or asynchronous mode.

See the “DisableAsync=[Yes|No]” option in Teradata DSN Options.

Using this feature is not recommended, because it is deprecated. For details, see Deprecated SQL Transformations.

Determines whether the X View is used.

See the “UseXViews=[Yes|No]” option in Teradata DSN Options.

Determines whether the Help Database is used.

See the “DontUseHelpDatabase=[Yes|No]” option in Teradata DSN Options.

Determines whether search pattern characters _ and % are used in search patterns or are passed as regular characters.

See the “IgnoreODBCSearchPattern=[Yes|No]” option in Teradata DSN Options.

Causes ODBC Driver for Teradata to determine if sessions on Teradata are to be reconnected after a system crash or reset is detected.

See the “EnableReconnect=[Yes|No]” option in Teradata DSN Options.

Controls whether message boxes appear.

See the “RunInQuietMode=[Yes|No]” option in Teradata DSN Options.

Using this option is not recommended, because it is deprecated. For more information, see DSN Option for RunInQuietMode.

See the “NoScan=[Yes|No]” option in Teradata DSN Options.

• When selected, ODBC Driver for Teradata parses SQL statements using the legacy parser.
• When cleared, SQL statements are parsed using the new parser.

See the "EnableLegacyParser=[Yes|No]" option in Teradata DSN Options.

Default = Selected. (When selected, do not select the Disable Parsing option.)

When cleared, ODBC Driver for Teradata converts CALL statements within an escape clause (that is, {CALL <name>(..)}) to EXEC statements.

See the “DisableCALLToEXECConversion=[Yes|No]” option in Teradata DSN Options.

When selected, ODBC Driver for Teradata uses regional settings to determine the decimal symbol.

If cleared, ODBC Driver for Teradata uses a “.” character as the decimal symbol and ignores the regional settings.

Enables LOB support. Impacts data type mapping within ODBC Driver for Teradata.

Leaving the default value selected is recommended, because this setting is deprecated. For details, see Deprecated SQL Transformations.

See the UseNativeLOBSupport=[Yes|No] description for this option on UNIX systems in Teradata DSN Options.

Leaving the default value selected is recommended, because this setting is deprecated. For details, see the ODBC Driver for Teradata User Guide (B035-2509).

See the description for this option on UNIX systems in the ODBC Driver for Teradata User Guide (B035-2509).

Default = Cleared

Determines how stored procedure output parameters are retrieved by ODBC Driver for Teradata.

When selected–the values of INOUT and OUT parameters are returned as a result set. The values can be retrieved by calling SQLFetch and SQLGetData, or SQLBindCol followed by SQLFetch. The result set containing the output parameters is the first returned by the database, preceding any generated by a stored procedure.

When cleared–the values of INOUT and OUT parameters are directly updated after the procedure call. All parameter markers must therefore be bound to variables before the call.

When Enable Data Encryption is checked – the option directs the ODBC Driver to use Data Encryption, causing ODBC Driver for Teradata and Teradata Database to communicate with each other in encrypted manner.

When Enable Data Encryption is cleared–Data Encryption is disabled.

Determines whether extended statement information is to be used by ODBC Driver for Teradata, provided that it is available from Teradata Database. Database versions from V2R6.2 and up support extended statement information, including metadata for parameters used in SQL requests and columns in result sets.

When EnableExtendedStmtInfo is Selected – ODBC Driver for Teradata requests and uses extended statement information from the database if supported. If extended statement information is available, then the ODBC API function SQLDescribeParam is supported and SQLGetFunctions returns SQL_TRUE (supported) for SQL_API_SQLDESCRIBEPARAM.

When EnableExtendedStmtInfo is cleared – ODBC Driver for Teradata does not request or use extended statement information from the database, even if supported. If extended statement information is unavailable, SQLDescribeParam is not supported and SQLGetFunctions returns SQL_FALSE (not supported) for SQL_API_SQLDESCRIBEPARAM.

The default value is determined by the database based on the option used in the Teradata Database CREATE or MODIFY USER statement.

The default setting is IAA. Because the Integer data type has been deprecated for the TIME format, it is not recommended.

For information, see DSN Option for Integer Time.

See the “DateTimeFormat=[[I|A] [I|A] [I|A]]” option in Teradata DSN Options.

Determines the result from requests that insert into identity columns (INSERT, INSERT ... SELECT, UPSERT, MERGE-INTO). These requests can optionally return a result set containing identity column values (also known as auto-generated keys) for the inserted rows.

Auto-generated key retrieval is not supported in Teradata Database versions prior to V2R6.2. The setting of Return Generated Keys has no effect when using a pre-V2R6.2 database server.

When Return Generated Keys is set to Identity Column or Whole Row, a request that inserts into tables containing identity columns returns two results: a row count with the number of inserted rows and a result set containing either the auto-generated keys as a single column or the complete rows inserted. The insert request becomes similar to a macro that first inserts and then selects the identity column or all columns of the rows just inserted.

When Return Generated Keys is set to No, the behavior of requests that insert into identity columns is not changed.

Use this option for applications (such as PowerBuilder) that require a database for their system catalog tables.

Enter a database name in the text box.

Using this feature is not recommended, because it is deprecated. For details, see Deprecated SQL Transformations.

See the “AppCatalogDB=<database name>” option in Teradata DSN Options.

Enter the value used to try to limit the Teradata response buffer size for SQL requests. This value can be adjusted dynamically if Teradata cannot send a result within the limited packet size defined.

See the “MaxRespSize=” option in Teradata DSN Options.

For more information, see Redisplay Reconnect Wait DSN Option.

Lists the port number to use to access Teradata Database. Do not change this value unless instructed to do so by Technical Support.

See the “TDMSTPortNumber=<integer>” option in Teradata DSN Options.

Provides enhanced ODBC state checking that detects SQLState 24000 according to the requirements in the ODBC SDK. This is a user-defined option.

Using this feature is not recommended, because it is deprecated. For details, see Deprecated SQL Transformations.

See the “StCheckLevel=[0 | 1 | 2]” option in Teradata DSN Options.

Defines a value corresponding to the number of seconds to wait when establishing a virtual circuit with Teradata for login. Enter an integer value.

See Teradata DSN Options.

Activates the print option when creating stored procedures.

See the “PrintOption=[N | P]” option in Teradata DSN Options.

Specifies the SPL option when creating stored procedures.

See the “SplOption=[Y | N]” option in Teradata DSN Options.

Data Source DNS Entries=undefined (default setting) is recommended for best results. This setting enables the ODBC Driver for Teradata to lookup DNS dynamically and find all available COPs for a given database name. Using this approach, ODBC Driver for Teradata will automatically detect new nodes added to the Teradata database (and DNS) in the future, without ODBC modification.

Data Source DNS Entries= 0 indicates that DNS does not contain cop entries for the database name. The database name will only be resolved by itself. No attempt will be made to resolve using a cop suffix. This behavior can be desirable in an environment utilizing DNS to load balance. When DNS is used for load balancing, administrators can configure DNS to provide a different IP address or multiple IP addresses in different order each time the database name is resolved using DNS.

Data Source DNS Entries= value. Entering a non-zero value indicates that DNS contains cop entries for the database name and the last cop entry is value. The first connection attempt will chose a random number between 1 and value. Each subsequent connection will then increment to the next number (round-robin). This approach will not encounter costly DNS resolution failures (how costly depends on how the DNS is configured). However, if additional entries are added to DNS at a later time, they will not be discovered by the ODBC Driver for Teradata unless the supplied value is increased.

• Unchecked (default) = disabled
• Checked = enabled

Path: Specifies the absolute path of the trace file.

The default is /tmp/ODBC.Trace.xxxxx. If the entry is missing, a default pathname of /tmp/ODBC.Trace.xxxxx is used, where xxxxx is the pid of the creating process.

Enables ODBC Driver for Teradata to bypass asking Teradata to perform Prepare before executing a request.

Using this feature is not recommended, because it is deprecated. For details, see Deprecated SQL Transformations.

See the “DisablePREPARE=[Yes | No]” option in Teradata DSN Options.

Valid for the Teradata DSN in ODBC Driver for Teradata.

Transmission Control Protocol (TCP) provides an option called TCP_NODELAY to control the transmission of data.

See the “TCPNoDelay=[Yes | No]” option in Teradata DSN Options.

When this option is selected – NULL values are assumed for the Catalog Name parameters in any of the Catalog API functions, even if the application passes a value.

When this option is cleared and a value is passed for the Catalog Name parameter instead of NULL – ODBC Driver for Teradata returns an error because catalogs are not supported by Teradata Database.

Allows Prepare to be executed for SQL request statements enclosed in parentheses or preceded by comments.

Using this feature is not recommended, because it is deprecated. For details, see Deprecated SQL Transformations.

See the “SQLWithCommentsOrParenthesis=[Yes | No]” option in Teradata DSN Options.

When this option is selected - the ODBC Driver reads ahead by requesting the next response message from the database when the current response message being processed is not the last. The database can have one request active for each session at any point in time. An active request is either an SQL request which is executing or a request for the next part of the result from an earlier SQL request.

When this option is cleared - the ODBC Driver only requests the next response message from the database when the current response message has been processed by the driver.

When this option is selected – the ODBC Driver is responsible for retrying the socket system calls when they have been interrupted by some event such as a SIGALRM.

When this option is cleared – the ODBC Driver returns an SQL_ERROR to the ODBC Application. The ODBC Application is responsible for recovery from the interrupted socket system calls.

When this option is selected– ODBC Driver for Teradata is directed to send DATE data for parameters bound as SQL_C_TIMESTAMP and SQL_TIMESTAMP.

This option should not be enabled for applications that are not using Microsoft Access Jet databases.

This option should only be selected for this circumstance, as this results in truncation of SQL_C_TIMESTAMP data to contain only the DATE portion.

Provides backwards compatibility for ODBC 2.x applications that have taken advantage of a defect in the ODBC Driver where the functionality of the Catalog APIs are noncompliant with the ODBC Programmer's Reference specification.

The behavior when a NULL value is passed to the SQLTables API for the SchemaName argument results in a search for tables belonging to the userid, DBC, and default database schema names, rather than a % search pattern as noted in the ODBC Programmer's Reference specification.

Returns an empty string for the CREATE_PARAMS column of SQLGetTypeInfo for SQL_TIMESTAMP data type, and disallows MC-ACCESS from using any TIMESTAMP precision value in Create Table text.