Syntax - 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

The order of the options is not important.



where:

Syntax Element Description
-e characterSet Option to specify that the tlogview output, including tlogview error messages, will be displayed in UTF-16.

The only valid value for characterSet is UTF16 (no hyphen).

If the -e characterSet is not specified, tlogview defaults to displaying in UTF-8.

-f "*" Option that requests the output of the public log and all private logs.
-f "*"-g Option that sorts the output of each private log separately, ordered by logname. The -g attribute must be used with "*", as shown in the following example:
tlogview –j JobID –f  "*" –g

This command gets all the public and private logs, grouped by log name.

If the TraceLevel attribute is operational, the sort is done by operator instance.
-f TWB_STATUS Option that identifies metadata, query job statistics, and status.

If this option is not specified, no metadata, statistics, or status are identified.

-f TWB _SRCTGT Option that identifies metadata, the query source, and target information.

If this option is not specified, no metadata, source, or target are identified.

-h Option that requests the job start time.

If this option is specified, tlogview prints the job start time as the first line on the output.

-j jobId Option that identifies the log output from a running or terminated Teradata PT job.

Use this option when viewing the log identified by jobId. The job can be running or terminated.

  • When the -W option is not used with this option for a running job, tlogview displays the log information produced to that point and terminates.
  • When the -W option is used with this option, tlogview displays the log information produced to that point, then it waits for more log information to be produced by the job, terminating when the target job terminates.

If the job is already terminated, tlogview displays the log information and terminates. In general, always use the -j option unless you move or rename the log file. In this case, use the -l option and specify the new location.

The -j and -l options are mutually exclusive.

-l logFileName Option that identifies a physical log file.

Use this option to view the log identified by a physical file name from a Teradata PT job. Log files are usually named with extensions of .out.

The -j and -l options are mutually exclusive.

-L logFilePath Option that helps specify the path to the physical log file.

If -L is not specified, tlogview will look for the physical log file in the TPT logs directory when used with -j jobId. If -L is not specified, tlogview will look in the current directory when used with -l logFileName.

If -L is specified, logFilePath will override the default logs location when used with -j jobId or -l logFileName.

-f logNameList Option that identifies a “from list,” that describes what log reports to view.

The default, if nothing is specified, is to view only public log reports. If both private and public log reports are requested, the “from list” must include the term “public” in the list. Listed items must be separated by commas, as shown in the following example:

tlogview –j jobID –f  PUBLIC,privateLog1,privateLog2

This command gets all the public logs and private logs 1 and 2.

-o outputFileName Option that designates a specific output file.

If this option is specified, tlogview writes the output to the specified file. If this option is not specified, output is written to standard output.

-p Option that lists the names of the private log reports contained in a target job log.
-v logviewFormat Option that specifies the log view format.

Use the following values to specify the output format of log messages:

  • %A for Task ID
  • %D for Date Time
  • %E for Destination
  • %G for Message Catalog
  • %L for Delta Time
  • %M for Message Text
  • %N for Node Name
  • %P for Process ID
  • %T for Task Name
  • %U for Message Number

For example, the following command displays log messages with time stamps, task names, and message texts separated by “-” characters:

   tlogview -j <jobID> -v "%D-%T-%M"
-W Option used in conjunction with the -j jobId option to tell tlogview to continue displaying additional log information until the target job terminates.
-w filterCriteria Option that specifies the filter criteria.

The filter criteria allows tlogview to do filtering on the log messages. Only those log messages satisfying the filter criteria are output from tlogview.

Without the -w option, tlogview selects all messages in the public and private logs.

For example, the following command displays log messages where Task Name equals “SELECT_2[0001]”.

tlogview -j <jobID> -w ‘TASKNAME=”SELECT_2[0001]”’