17.10 - Attributes Provided by Teradata Utilities - Access Module

Teradata® Tools and Utilities Access Module Programmer Guide

Product
Access Module
Release Number
17.10
Release Date
June 2021
Content Type
Programming Reference
Publication ID
B035-2424-061K
Language
English (United States)

The Teradata utilities can provide the following attributes to Access Modules. CHARSET_NAME and CHARSET_NUMBER, for example, are part of the session character set that is passed by pmAPutAttr() from the client utility to an Access Module.

Teradata Utility Attributes 
Name of Attribute Provided by Attribute Value
BYTE_ORDER FastExport, FastLoad, MultiLoad, and TPump job scripts Allows explicit ordering of the byte sequences that are unique to character sets found at the beginning of a file. This attribute allows you to explicitly define the byte order for a specific platform.

Attribute values are LITTLE_ENDIAN or BIG_ENDIAN.

CHARSET_NAME FastExport, FastLoad, MultiLoad, and TPump job scripts Character set name. This attribute is optional.

Attribute values are UTF16, UTF8 or ASCII.

CHARSET_NUMBER FastExport, FastLoad, MultiLoad, and TPump job scripts One-byte ID of the character set.

This attribute is optional.

TBR_OP_HANDLE Teradata PT DataConnector operator Pointer to Teradata PT operator handle. The pointer communicates with Teradata PT functions.

The Teradata PT DataConnector operator always sends this attribute, although the Access Module does not have to use it.

TIMEOUT_SECONDS Teradata PT, TPump, and DataConnector operator An I/O time-out value in seconds.

This value is in character form and must be converted to an integer value for use.

WRITE_BOM FastExport, FastLoad, MultiLoad, and TPump job scripts Byte order marker. This attribute is optional.

Attribute values are YES or NO, where YES causes a Byte Order mark to be written to the beginning of the file.