17.00 - Teradata TPump Command Input - Parallel Data Pump

Teradata® Parallel Data Pump Reference

Parallel Data Pump
June 2020
Programming Reference

Teradata TPump commands perform two types of activities, Support and Task.

The following table provides a description of those activities and functions.

Teradata TPump Command Input Activities 
Activity Description
Support Support commands establish the Teradata TPump sessions with the database and establish the operational support environment for Teradata TPump.

Support commands are not directly involved in specifying a Teradata TPump task.

Task The Teradata TPump task commands specify the actual processing that takes place for each MultiLoad task.

The task commands, combined with Teradata SQL INSERT, UPDATE, and DELETE statements, are used to define Teradata TPump IMPORT and DELETE tasks.

Teradata TPump Commands for Support and Task Activities

The following table lists the Teradata TPump commands that perform the support and task activities.

Teradata TPump Commands 
Activity Teradata TPump Command Function
Support ACCEPT Allows the value of one or more utility variables to be accepted from either a file or an environment variable.
DATEFORM Lets the form of the DATE data type specifications be defined for the Teradata TPump job.
DISPLAY Writes messages to the specified destination.
ELSE (see IF, ELSE, and ENDIF) Followed by commands and statements which execute when the preceding IF command is false.
ENDIF (see IF, ELSE, and ENDIF) Delimits the group of Teradata TPump commands and statements that were subject to previous IF or ELSE commands or both.
IF (see IF, ELSE, and ENDIF) When followed by a conditional expression, initiates execution of subsequent commands and statements.
LOGDATA Supplies parameters to the LOGMECH command beyond those needed by the logon mechanism, such as user ID and password, to successfully authenticate the user.
LOGMECH Identifies the appropriate logon mechanism by name.
LOGOFF Disconnects all active sessions and terminates Teradata TPump support on the client.
LOGON Specifies the LOGON string to be used in connecting all sessions established by Teradata TPump.
LOGTABLE Identifies the table to be used for journaling checkpoint information required for safe, automatic restart of the Teradata TPump support environment in the event of a client or database hardware platform failure.
NAME Sets the variable SYSJOBNAME to the jobname string specified. The jobname string can be up to 16 bytes in length and can contain kanji characters.
ROUTE Identifies the destination of output produced by the Teradata TPump support environment.
RUN FILE Invokes the specified external source as the current source of commands and statements.
SET Assigns a data type and a value to a utility variable.
SYSTEM Suspends Teradata TPump to issue commands to the local operating system.
Task BEGIN LOAD Specifies the kind of Teradata TPump task to be executed, the target tables to be used, and the parameters for executing the task.
FIELD Defines a field of the data source record. Used with LAYOUT command.
DML Defines a label and error treatment options for the Teradata SQL DML statements following the DML command.
END LOAD Indicates completion of Teradata TPump command entries and initiates execution of the task.
FILLER Defines a field in the data source that is not sent to the database. Used with LAYOUT command.
IMPORT Identifies the data source, the layout, and the DML operations to be performed, with optional conditions for performing these operations.
LAYOUT Introduces the record format of the data source to be used in the Teradata TPump task. This command is followed by a sequence or combination of FIELD, FILLER, and TABLE commands.
PARTITION Establishes session partitions to transfer SQL requests to the database.
TABLE Identifies a table whose column names and data descriptions are used as the field names and data descriptions of the data source records. Used with LAYOUT command.