Teradata ODBC Driver Options - ODBC Driver for Teradata - 16.20

ODBC Driver for Teradata® User Guide

prodname
ODBC Driver for Teradata
vrm_release
16.20
category
User Guide
featnum
B035-2526-108K

Click the Options button in the ODBC Driver Setup for Teradata Database dialog box for the Driver Options dialog box to appear. Use this dialog box to configure additional options and formats. Teradata ODBC Driver Options are listed in the table below.



Field, Check Box, or Button Description
Use Column Names Default = Selected

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

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

Use X Views Default = Cleared

Determines whether the X View is used.

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

No HELP DATABASE Default = Cleared

Determines whether the Help Database is used.

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

Ignore Search Patterns Default = Cleared

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.

Disable Parsing Default = Cleared
Disables or enables parsing of SQL statements by ODBC Driver for Teradata. When parsing is enabled, the driver parses SQL statements and transforms ODBC escape sequences into SQL.
  • When selected, ODBC Driver for Teradata does not parse SQL statements.
  • When cleared, SQL statements are parsed.

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

Log Error Events Default = Cleared

When selected, ODBC Driver for Teradata performs error logging that appears in the Event Viewer.

When cleared, error logging is not performed.

Use Regional Settings for Decimal Symbol Default = Selected

(Windows) Allows the application to decide which symbol is used as a decimal separator while retrieving decimal data.

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.

Enable Data Encryption Default = Cleared

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.

Enable Extended Statement Information Default = Selected

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.

Session Mode Specifies the mode (Teradata or ANSI) for sessions on Teradata Database. The selected mode applies for the duration of the session.

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

DateTime Format Assigns the ANSI formats for DATE, TIME, and TIMESTAMP.

The default setting is AAA. IAA is optional. Because the Integer data type has been deprecated for the TIME format, it is not recommended. For information, see Integer Time.

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

Return Generated Keys Default = No

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.

Valid values are No, Identity Column, and Whole Row:
  • No = Auto-generated key retrieval is disabled (default)
  • Identity Column = Retrieve identity column only
  • Whole Row = Retrieve entire row(s)

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.

UPT Mode

Default = NOTSET

Enables Unicode Pass Through Mode for the ODBC Application.

The default value is NOTSET, which means that the UPT Mode set by the database is used. The ODBC Driver for Teradata does not send anything to the database when this option is set.

UPTON: ODBC Driver for Teradata sends “SET SESSION CHARACTER SET UNICODE PASS THROUGH ON” to the database while connecting, thereby enabling UPT MODE for that session.

UPTOFF: ODBC Driver for Teradata sends “SET SESSION CHARACTER SET UNICODE PASS THROUGH OFF” to the database while connecting, thereby disabling UPT MODE for that session.

See the "UPTMode=[NotSet|UPTOn|UPTOff]" option in Teradata DSN Options.

UDF Upload
Enable Client Side UDF Source

Default=Cleared.

If this is unchecked, the driver will not support UDF source file uploads.

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

UDF Upload Path

Fully qualified path where source files will be found. If defined, the driver looks at this location for files the database requests, unless the database gives a fully qualified path as part of the file name.

No relative paths using “..” are allowed in this value.

The default value displayed in the field (Please enter the UDF folder path) MUST be changed to the value you wish to use (either a valid path or empty). Delete the default value to leave the field empty.

If Enable Extended Statement Information is checked:
  • The path you specify in UDF Root Directory will be prepended to all file names specified with an EXTERNAL NAME clause of a CREATE FUNCTION or REPLACE function.
  • To use fully qualified file names in EXTERNAL NAME clauses, leave this field empty.

See "UDFUploadPath=<path>" option in Teradata DSN Options.

Warning group box
Advanced

Click to bring up the dialog box. The dialog box contains further setting options available; however, it is strongly recommended NOT to change these settings.