Optional Attributes - Parallel Transporter

Teradata® Parallel Transporter Reference
Product
Parallel Transporter
Release Number
17.10
Published
February 2022
Language
English (United States)
Last Update
2023-11-29
dita:mapPath
abr1608578396711.ditamap
dita:ditavalPath
obe1474387269547.ditaval
dita:id
ogv1478610452101
Product Category
Teradata Tools and Utilities

Use the attribute definition list syntax in the Teradata PT DEFINE OPERATOR statement to declare the optional attribute values for the Schema Mapping operator.





where:

Schema Mapping Operator Attribute Descriptions 
Syntax Element Description
AllRecords =‘option’ Optional attribute that specifies whether to display all records whose data format conforms to the data format specified in the DEFINE SCHEMA statement for the Teradata PT schema mapping job.

Valid options are:

  • ‘No’ = display 1 records (default).
  • ‘Yes’ = display all records.
FormatFields = ‘option’ Optional attribute that specifies whether to display the hexadecimal offset of record fields and the record fields themselves in hexadecimal format from the beginning of the field.

FormatFields does not display control bytes. For example, FormatFields does not display the end-of-line or end-of-file marker byte.

Valid options:

  • ‘No’ = do not display this format (default).
  • ‘Yes’ = display the hexadecimal offset of record fields (by record field) and the record fields in hexadecimal.
DumpFieldsNoTrans = ‘option’ Optional attribute that specifies whether to display fields in hexadecimal format, but not to display the transformation of hexadecimal characters into ASCII characters.

Valid options:

  • ‘No’ = do not display this format unless all the other format display options are set to ‘No’ (default).
  • ‘Yes’ = display fields in hexadecimal characters but not ASCI characters.
DumpFieldsWithTrans = ‘option’ Optional attribute that specifies whether to display fields in hexadecimal format, including the transformation of hexadecimal characters into ASCII characters.

Valid options:

  • ‘No’ = do not display this format (default).
  • ‘Yes’ = display fields in hexadecimal characters as well as ASCII characters.
DumpRecordsNoTrans = ‘option’ Optional attribute that specifies whether to display records in hexadecimal format, but not to display the transformation of hexadecimal characters into ASCII characters.

Valid options:

  • ‘No’ = do not display this format (default).
  • ‘Yes’ = display records in hexadecimal format but not ASCII characters.
PrivateLogName = ‘option’ 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. By default, no diagnostic trace messages are produced. Diagnostic trace messages are produced only when the user sets a valid value for the TraceLevel attribute.

For more information about the tlogview command, see Teradata PT Utility Commands.
DumpRecordsWithTrans = ‘option’ Optional attribute that specifies whether to display records in hexadecimal format, including the transformation of hexadecimal characters into ASCII characters.

Valid options:

  • ‘No’ = do not display this format (default).
  • ‘Yes’ = display records in hexadecimal characters as well as ASCII characters.
RecordCount = integer Optional attribute that indicates the number of records to be displayed whose data format conforms to the user-provided attributes and the data format specified in the DEFINE SCHEMA statement for the Teradata PT schema mapping job.

Valid values: any valid positive integer from 0 to 4294967296.
SkipRows= integer Optional attribute that indicates the number of rows to be skipped before starting to display records whose data format conforms to the user-provided attributes and the data format specified in the DEFINE SCHEMA statement for the Teradata PT schema mapping job.

For example, if RecordCount is set to 10 and SkipRows is set to 5, then 5 rows are skipped and the Schema Mapping operator displays the last 5 records and the record numbers would be 6 to 10.

Valid value: any positive integer.

Default value for SkipRows is 0. This means no records will be skipped.
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' = TraceLevel turned off (default).
  • 'All' = enables tracing for all of the above activities
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.