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 FastLoad INMOD Adapter operator.

where:

FastLoad INMOD Adapter Operator Attribute Descriptions 
Syntax Element Description
IndicatorMode = 'mode' Optional attribute that specifies whether the indicator byte(s) is included at the beginning of each input record. The values are:
  • 'Yes' (or 'Y') = indicator mode data
  • 'No' (or 'N') = nonindicator mode data (default)
InmodName = 'moduleName' Required attribute that specifies the name of the FastLoad INMOD routine.

The INMOD is found in the directory defined in the system-dependent library path. Using the “./” syntax (for example ./flinmod) 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 diagnostic trace messages produced by the operator.

The file name is appended with the operator instance number. A “-1” is appended to the log name for instance 1. For example, if PrivateLogName = 'DClog', then the actual log name for instance 1 is DClog-1. Similarly, for instance 2, it is DClog-2, etc.

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 of the output is stored in the public log.

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

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, and do not specify the TraceLevel attribute, minimal statistics are displayed in the log file, including:

  • Name of files as they are processed
  • Notice when sending rows begins
  • Upon completion of each file, the number of rows processed and the CPU time consumed.
  • Total files processed and CPU time consumed by each instance of the DataConnector operator.

The PrivateLogFile attribute default is used only if a non-zero TraceLevel attribute is specified.

If no TraceLevel attribute is specified, or if the specified value is 'None', and the PrivateLogFile attribute is specified, the TraceLevel is set to 'Milestones'.

  1. The TraceLevel attribute is provided as a diagnostic aid only. The amount and type of additional information provided by this attribute will change to meet evolving needs from release to release.
  2. The recommended TraceLevel value is 'None', which produces NO log file. Specifying any value greater than 'IO_Counts' produces a very large amount of diagnostic information.
VARCHAR Keyword specifying VARCHAR as the data type of the defined attribute.