The following connection option descriptions are listed alphabetically by the GUI name that appears on the driver Setup dialog box. The connection string attribute name, along with its short name, is listed immediately underneath the GUI name. For example:
In most cases, the GUI name and the attribute name are the same; however, some exceptions exist. If you need to look up an option by its connection string attribute name, please refer to the alphabetical table of connection string attribute names.
Also, a few connection string attributes, for example, Password, do not have equivalent options that appear on the GUI. They are in the list of descriptions alphabetically by their attribute names.
Table 23-1 lists the connection string attributes supported by the driver.
where string is an account string.
The password for the Kerberos, LDAP, NTLM, and TD authentication mechanisms. The Authentication Password option cannot be specified through the driver Setup dialog box and should not be stored in a data source. It is specified through the Logon dialog box or a connection string.
where pwd is a valid password.
where userid is a valid user ID.
ip_address is an IP address to appear in the drop-down list of the Logon dialog box.
alias is an alias to appear in the drop-down list of the Logon dialog box.
Separate multiple IP addresses or aliases with commas. The same restrictions apply as described for the DBCName or Alias option.
IP_address is the IP address of the Teradata server.
alias is the alias of the Teradata server.
If set to IP_address, the time the driver waits for connections to be established is faster. The disadvantage is that if the server designated by that IP address is unavailable, the connection fails and the driver does not attempt to fail over to another IP address.
If set to alias, the time the driver waits for connections to be established is slower because the driver must search a local hosts file to resolve the alias to an IP address. The advantage is that the driver fails over the connection to an alternate IP address if the first address fails.
To use aliases, a local hosts file that maps aliases to IP addresses is required. Aliases cannot be more than eight characters. In the hosts file, you must specify the aliases and map each of them to an IP address in the order that you want the driver to attempt the connections. For example:
where NCR5100 is an alias and
COPn (where
n = 1, 2, 3, ..., 128) is a suffix that sets the order of failover connection attempts. The eight-character limit on the alias does not include the suffix. You can enter a maximum of 128 COP (communications processor) entries per host.
NOTE: Although you must add a COP suffix to the alias in the hosts file, do not specify the suffix when entering the alias in the DBCName or Alias field of the Setup dialog box. Only specify the alias.
where database_directory is the full path name of the directory in which the data files are stored. If no directory is specified, the current working directory is used.
where string is a valid role.
An optional long description of a data source. This description is not used as a runtime connection attribute, but does appear in the ODBC.INI section of the Registry and in the odbc.ini file.
where string is a description of a data source.
NOTE: Before you use this value, verify that the server is encryption capable. Data encryption may adversely affect performance because of the additional overhead (mainly CPU usage) required to encrypt and decrypt data.
If set to 1 (Enabled), the driver queries the server to see if it supports the Statement Information parcel. If the server supports the Statement Information parcel, the driver requests the Statement Information parcel and enables auto-generated key retrieval and SQLDescribeParam support. Use this value if you want to enable the Return Generated Keys option.
If set to 0 (Disabled), the driver provides backward compatibility for applications without LOB support that are using a version of Teradata Database prior to V2R5.1. The mappings are:
This value can improve performance if your application does not send data to, or retrieve it from, LOB columns. You may receive an error if you disable this option and try to retrieve data from a LOB column.
If set to 1 (Enabled), the driver attempts to reconnect to the saved sessions; however, sessions cannot be reconnected until the Teradata system is available. After a session has been reconnected, applications can expect to receive error messages describing why the ODBC function failed, as well as a status report describing the post-recovery state.
An Internet Assigned Numbers Authority (IANA) value. You must specify a value for this option if your application is not Unicode‑enabled or if your database character set is not Unicode. Refer to
Chapter 4 “Internationalization, Localization, and Unicode” in the
DataDirect Connect Series for ODBC Reference for details.
where IANA_code_page is one of the valid values listed in
Chapter 1 “Values for the Attribute IANAAppCodePage” in the
DataDirect Connect Series for ODBC Reference. The value must match the database character encoding and the system locale.
where x is a positive integer.
If set to x, the driver waits the specified number of seconds.
Determines whether the driver converts the {CALL <name>(...)} statement to
EXEC name(...).
If set to Yes (Enabled), the driver considers the {CALL <name>(...)} statement as the SQL for MACRO execution and converts it to
EXEC name(...).
If set to No (Disabled), the driver does not convert {CALL name(...)} statements to
EXEC name(...), and considers them as CALL statements for Stored Procedure Execution.
where string is the name of a data source.
The password that the application uses to connect to your database. The Password option cannot be specified through the driver Setup dialog box and should not be stored in a data source. It is specified through the Logon dialog box or a connection string.
where pwd is a valid password.
where the port_name is the port number of the server listener. Check with your database administrator for the correct number.
where string is a valid profile.
where string is a valid domain.
An error message or warning can occur if an ODBC call causes a conversion error, or if an error occurs during code page conversions to and from the database or to and from the application. The error or warning generated is
Code page conversion error encountered. In the case of parameter data conversion errors, the driver adds the following sentence:
Error in parameter x, where
x is the parameter number. The standard rules for returning specific row and column errors for bulk operations apply.
|
●
|
User name: A user name for the default Teradata database. If TeraSSO allows fully qualified user names, the user name may contain a domain or realm, for example, {judy@linedata}. Values containing a character like @ must be enclosed in braces.
|
|
●
|
Realm: The Kerberos domain. (The equivalent connection string attribute is AuthenticationDomain.)
|
|
●
|
Realm: The LDAP domain. (The equivalent connection string attribute is AuthenticationDomain.)
|
|
●
|
Profile: The Teradata Profile. (The equivalent connection string attribute is TDProfile.)
|
|
●
|
Default Role: The Teradata Role. (The equivalent connection string attribute is TDRole.)
|
|
●
|
Realm: The NTLM domain. (The equivalent connection string attribute is AuthenticationDomain.)
|
A string that is passed as a parameter to the authentication method. The string is ignored by the ODBC driver and is passed to the TeraSSO function that is called to set the authentication method.
where string is a string of characters. The characters [] {} () , ; ? * = ! @ must be enclosed in curly braces.
ASCII | UTF16 (valid only for V2R6.x servers) | LATIN1252_0A | LATIN9_0A | LATIN1_0A | Shift-JIS | EUC | BIG5 | GB | NetworkKorean
If set to Yes (Enabled), SQLTables() and SQLProcedures() use dbc.tablesX and dbc.databasesX instead of dbc.tables and dbc.databases. Also, SQLColumns() and SQLProcedureColumns() use dbc.columnsX instead of dbc.columns. SqlStatistics() uses dbc.tablesizeX instead of dbc.tablesize. The X tables only contain information that the user has permission to access. These tables are optional for Teradata, so verify that they exist.
If set to No (Disabled), SQLTables() and SQLProcedures() use dbc.tables and dbc.databases. Also, SQLColumns() and SQLProcedureColumns() use dbc.columns. SqlStatistics() uses dbc.tablesize.
where user_name is a valid user name.
The default user ID that is used to connect to your database. Your ODBC application may override this value or you may override it in the logon dialog box or connection string.
where userid is a valid user ID with permissions to access the database.
The user name is interpreted in the context of the authentication mechanism. If, for example, the authentication mechanism is NTLM, the user name is assumed to be a Windows user name.
If TeraSSO allows fully qualified user names, the user name may contain a domain or realm, for example, {judy@linedata}. Values containing a character such as @ must be enclosed in curly braces.