16.10 - Required and Optional Attributes - Parallel Transporter

Teradata Parallel Transporter Reference

Product
Parallel Transporter
Release Number
16.10
Published
July 2017
Content Type
Programming Reference
Publication ID
B035-2436-077K
Language
English (United States)

Use the attribute definition list syntax in the Teradata PT DEFINE OPERATOR statement to declare the required and optional attribute values for the FastExport OUTMOD Adapter operator.



where:

FastExport OUTMOD Adapter Operator Attribute Definitions 
Syntax Element Description
AccessModuleInitStr = 'initString' Optional attribute that specifies the initialization string for the specified access module. For initString values to the Initialization String section for each access module in the Teradata Tools and Utilities Access Module Reference (B035-2425).
AccessModule Name = 'name' Optional attribute that specifies the name of the access module file, where the value for name is dependent on the following:

Teradata Access Module for Named Pipes

  • libnp_axsmod.dylib on the Apple OS X platform
  • np_axsmod.soon all other UNIX platforms
  • np_axsmod.dllon Windows platforms

Teradata Access Module for WebSphere MQ for Teradata Parallel Transporter (client version)

  • libmqsc.dylibon the Apple OS X platform
  • libmqsc.so on all other UNIX platforms
  • libmqsc.dll on Windows platforms

Teradata Access Module for WebSphere MQ for Teradata Parallel Transporter (server version)

  • libmqs.dylib on the Apple OS X platform
  • libmqs.so on all other UNIX platforms
  • libmqs.dll on Windows platforms

Use your shared library file name if you use a custom access module.

Access module names do not need a suffix since the operator appends the correct suffix for the platform used.

Large File Access Module is no longer available because the DataConnector operator now supports file sizes greater than 2 gigabytes on Windows, HP-UX, AIX, and Solaris running on SPARC systems, provided system parameters are appropriately set.

Teradata PT supports the standalone version of the Teradata Access Module for Named Pipes and Teradata Access Module forWebSphere MQ.

The Teradata PT version of the Teradata Access Module for Named Pipes and Teradata Access Module for WebSphere MQ is not supported.

FileName = 'fileName' Optional attribute that specifies the name of the file. On the UNIX system, limited to 255 bytes.
Format = 'option' Optional attribute that specifies the logical record format of the file being read.

A value is not needed as long as the attached access module generates data in a predefined format. If no predefined format exists, one of the following values is required because no system default exists:

  • 'Binary' = 2-byte integer, n, followed by n bytes of data. This data format requires rows to be 64KB (64260 data bytes) or smaller. In this format:

    The data is prefixed by a record-length marker.

    The record-length marker does not include the length of the marker itself.

    The record-length is not part of the transmitted data.

  • 'Binary4' = 4-byte integer, followed by n bytes of data. This data format supports rows up to 1MB (1000000 data bytes) in size. In this format:

    The data is prefixed by a record-length marker.

    The record-length marker does not include the length of the marker itself.

    The record-length is not part of the transmitted data.

  • 'Delimited' = in text format with each field separated by a delimiter character. When you specify Delimited format, you can use the optional TextDelimiter attribute to specify the delimiter character. The default is the pipe character ( | ).

    When the assigned value of an operator attribute is ‘Delimited’ all columns in the schema specified for this operator must be of the VARCHAR data type. Non-VARCHAR specifications will result in an error.

  • 'Formatted' = both prefixed by a record-length marker and followed by an end-of-record marker. This data format requires rows to be 64KB (64260 data bytes) or smaller.sw. In this format:

    The record-length marker does not include the length of the marker itself.

    Neither the record-length nor the end-of-record marker is part of the transmitted data.

  • 'Formatted4' = both prefixed by a 4-byte record-length marker and followed by an end-of-record marker. This data format supports rows up to 1MB (1000000 data bytes) in size. In this format:

    The record-length marker does not include the length of the marker itself.

    Neither the record-length nor the end-of-record marker is part of the transmitted data.

  • 'Text' = character data separated by an end-of-record (EOR) marker. The EOR marker can be either a single-byte linefeed (X'0A') or a double-byte carriage-return/line-feed pair (X'0D0A'), as defined by the first EOR marker encountered for the first record.
  • 'Unformatted' = not formatted. Unformatted data has no record or field delimiters, and is entirely described by the specified Teradata PT schema.
IndicatorMode = 'mode' Optional attribute that specifies whether indicator byte(s) is included at the beginning of each record.
  • 'Yes' (or 'Y') = indicator mode data
  • 'No' (or 'N') = nonindicator mode data (default)
OpenMode = 'mode' Optional attribute that specifies the read/write access mode.
  • 'Write' = Write-only access (default)
  • 'Write Append' = Write-only access appending to existing file
OutmodName = 'moduleName' Required attribute that specifies the name of the FastExport OUTMOD routine to be loaded.

The OUTMOD is found in the directory defined in the system-dependent library path. Using the “./” syntax (for example ./floutmod) indicates the directory in which the job is run.

PrivateLogName = 'logName' Optional attribute that specifies the name of a log that is maintained by the Teradata PT Logger inside the public log. The private log contains all of the output provided by the operator.

The private log can be viewed using the tlogview command as follows, where jobId is the Teradata PT job name and privateLogName is the value for the operator’s PrivateLogName attribute:

tlogview -j jobid -f privatelogname

If the private log is not specified, all output is stored in the public log.

For more information about the tlogview command, see Teradata PT Utility Commands.

TextDelimiter = 'c' Optional attribute that specifies the character that separates fields in delimited records.

The default is the pipe character ( | ).

TraceLevel = 'level' Optional attribute that specifies the types of diagnostic messages that are written by each instance of the operator to the public log (or private log, if one is specified using the PrivateLogName attribute). The diagnostic trace function provides more detailed information in the log file to aid in problem tracking and diagnosis.

The trace levels are:

  • 'None' = disables the trace function (default).
  • 'Milestones' = enables the trace function only for major events such as initialization, access module attach/detach operations, file openings and closings, error conditions, and so on
  • 'IO_Counts' = enables the trace function for major events plus I/O counts
  • 'IO_Buffers' = enables the trace function for major events and I/O counts plus I/O buffers
  • 'All' = enables the trace function for major events and I/O counts and buffers plus function entries

If you use the PrivateLogFile attribute to specify a log file, the TraceLevel value defaults to 'Milestones'.

The TraceLevel attribute is provided as a diagnostic aid only. The amount and type of additional information provided by this attribute changes to meet evolving needs from release to release.