17.00 - Teradata TPump Commands - Parallel Data Pump

Teradata® Parallel Data Pump Reference

Parallel Data Pump
June 2020
Programming Reference

The following table is an alphabetical list of the commands supported by Teradata TPump. The syntax and use of these commands is described in detail in the following command description topics.

Teradata TPump Commands 
Command Definition
ACCEPT Accepts the data type and value of one or more utility variables from an external source.
BEGIN LOAD Indicates the start of a Teradata TPump task and specifies the parameters for executing the task.
DATEFORM Defines the form of the DATE data type specifications for the Teradata TPump job.
DISPLAY Writes messages to the specified destination.
DML Defines a label and error treatment option for the Teradata SQL DML statements following the DML command. INSERT, UPDATE, DELETE, and EXECUTE are the DML statement options.
ELSE The ELSE command is followed by commands and statements that execute when the preceding IF command is false. See IF, ELSE, and ENDIF.
ENDIF Exits from the conditional expression IF or IF/ELSE command sequences. ENDIF is followed by commands and statements resuming the program. See IF, ELSE, and ENDIF.
END LOAD Indicates completion of Teradata TPump command entries and initiates the task. This is the last command of a Teradata TPump task.
FIELD Defines a field of the data source record. Fields specified by this command are sent to the database. This command is used with the LAYOUT command.
FILLER Defines a field in the data source that is not sent to the database. This command is used with the LAYOUT command.
IF The IF command is followed by a conditional expression which, if true, executes commands and statements following the IF command. See IF, ELSE, and ENDIF.
IMPORT Identifies the data source, layout, and optional selection criteria to the client program.
LAYOUT Specifies layout of the externally stored data records to be used in the Teradata TPump task. This command is used in conjunction with an immediately following sequence of FIELD, FILLER, and TABLE commands.
LOGOFF Disconnects all active sessions and terminates execution of Teradata TPump on the client.
LOGON Establishes a Teradata SQL session on the database, and specifies the LOGON string to be used in connecting all sessions required by subsequent functions.
LOGTABLE Identifies the table to be used for journaling checkpoint information required for safe, automatic restart of Teradata TPump in the event of a client or database system failure.
NAME Sets the utility variable &SYSJOBNAME with a job name of up to 16 characters.
PARTITION Establishes session partitions to transfer SQL requests to the database.
ROUTE Identifies the destination of output produced by Teradata TPump.
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.
TABLE Identifies a table whose column names and data descriptions are used as the names and data descriptions of the input record fields. Used in place of, or in addition to, the FIELD command. This command is used with the LAYOUT command.
When UTF-16 session character set is used, the TABLE command will generate a field of CHAR(2n) for the CHAR(n) typed column and a field of VARCHAR(2m) for the VARCHAR(m) typed column because each character in the column takes 2-byte storage when using UTF-16 session character set.