August 17, 2023

tTeradataTPump – Docs for ESB 5.x



tTeradataTPump Properties

Component Family




This component inserts, updates, or deletes data in the Teradata
database with the TPump loading utility which allows near-real-time
data to be achieved in the data warehouse.


Use this component to insert, update, or delete data in the
Teradata Database, particularly for environments where batch windows
are shrinking and warehouse maintenance overlaps normal working

Basic settings

Property type

Either Built-in or

Since version 5.6, both the Built-In mode and the Repository mode are
available in any of the Talend solutions.



Built-in: No property data stored



Repository: Select the repository
file in which the properties are stored. The fields that follow are
completed automatically using the data retrieved.


Execution platform

Select the Operating System type you use.



Host name or IP address of the database server.



Database name.


Username and

DB user authentication data.

To enter the password, click the […] button next to the
password field, and then in the pop-up dialog box enter the password between double quotes
and click OK to save the settings.



Name of the table to be written. Note that only one table can be
written at a time.


Schema and Edit

A schema is a row description. It defines the number of fields to be processed and passed on
to the next component. The schema is either Built-In or
stored remotely in the Repository.

Since version 5.6, both the Built-In mode and the Repository mode are
available in any of the Talend solutions.



Built-In: You create and store the schema locally for this
component only. Related topic: see Talend Studio
User Guide.



Repository: You have already created the schema and
stored it in the Repository. You can reuse it in various projects and Job designs. Related
topic: see Talend Studio User Guide.


Click Edit schema to make changes to the schema. If the
current schema is of the Repository type, three options are

  • View schema: choose this option to view the
    schema only.

  • Change to built-in property: choose this option
    to change the schema to Built-in for local

  • Update repository connection: choose this option to change
    the schema stored in the repository and decide whether to propagate the changes to
    all the Jobs upon completion. If you just want to propagate the changes to the
    current Job, you can select No upon completion and
    choose this schema metadata again in the [Repository


Script generated folder

Browse your directory and select the destination of the file which
will be created.


Action to data

On the data of the table defined, you can perform:

Insert: Add new entries to the
table. If duplicates are found, job stops.

Update: Make changes to existing

Insert or update: Insert a new record. If the record with
the given reference already exists, an update would be made.

Delete: Remove entries
corresponding to the input flow.


It is necessary to specify at least one
column as a primary key on which the Update and Delete
operations are based. You can do that by clicking Edit Schema and selecting the
check box(es) next to the column(s) you want to set as
primary key(s).


Where condition in case Delete

Type in a condition, which, once verified, will delete the

This field appears only when Delete is selected from the Action to data drop-down list.


Load file

Browse your directory and select the file from which you want to
load data.


Field separator

Character, string or regular expression to separate fields.


Error file

Browse your directory and select the destination of the file where
the error messages will be recorded.

Advanced settings

Define Log table

This check box is selected to define a log table you want to use
in place of the default one that is the database table you defined
in Basic settings. The syntax
required to define the log table is



This field allows you to define your BEGIN LOAD command to
initiate or restart a TPump task. You can specify the number of
sessions to use, the error limit and any other parameters needed to
execute the task. The default value is:


For more information, see Teradata Parallel Data Pump


Return tpump error

Select this check box to specify the exit code number to indicate
the point at which an error message should display in the


Define character set

Specify the character encoding you need use for your system


Catcher Statistics

Select this check box to collect log data at the component

Global Variables

EXIT_VALUE: the process exit code. This is an After
variable and it returns an integer.

ERROR_MESSAGE: the error message generated by the
component when an error occurs. This is an After variable and it returns a string. This
variable functions only if the Die on error check box is
cleared, if the component has this check box.

A Flow variable functions during the execution of a component while an After variable
functions after the execution of the component.

To fill up a field or expression with a variable, press Ctrl +
to access the variable list and choose the variable to use from it.

For further information about variables, see Talend Studio
User Guide.


This component offers the flexibility of the DB query and covers
all possible SQL queries.


The activity of this component can be logged using the log4j feature. For more information on this feature, see Talend Studio User

For more information on the log4j logging levels, see the Apache documentation at

Scenario: Inserting data into a Teradata database table

In this scenario, you create a Job using tTeradataTPump to insert customer data into a Teradata database table
and specify the exit code to be displayed in the event of an exception error.

Three components are used in this Job:

  • tRowGenerator: generates rows as required
    using random customer data taken from a list.

  • tFileOutputDelimited: outputs the customer
    data into a delimited file.

  • tTeradataTPump: inserts the customer data
    into the Teradata database table in the Tpump mode.

Dropping components

  1. Drop the required components: tRowGenerator, tFileOutputDelimited and tTeradataTPump from the Palette onto the design workspace.

  2. Link tRowGenerator to tFileOutputDelimited using a Row > Main

  3. Link tRowGenerator to tTeradataTPump using a Trigger > On SubjobOk


Configuring the components

  1. Double click tRowGenerator to open the
    [tRowGenerator Editor] window.

    In the [tRowGenerator Editor] window,
    define the data to be generated. For this Job, the schema is composed of two
    columns: ID and Name.


    Enter the Number of Rows for
    to generate.

  2. Double click tFileOutputDelimited to
    define its properties in the Component

  3. Next to File Name, browse to the output
    file or enter a name for the output file to be created.

  4. Between double quotation marks, enter the delimiters to be used next to
    Row Separator and Field Separator.


    Click Edit schema and check that the
    schema matches the input schema. If need be, click Sync Columns.

  5. Double click tTeradataTPump to open its
    Component view.

    In the Basic settings tab of the
    Component view, define the tTeradataTPump parameters. I

  6. Enter the Database name, User name and Password in accordance with your database authentication

  7. Specify the Table into which you want to
    insert the customer data. In this scenario, it is called

  8. In the Script generated folder field,
    browse to the folder in which you want to store the script files

  9. In the Load file field, browse to the
    file which contains the customer data.

  10. In the Error file field, browse to the
    file in which you want to log the error information.

  11. In the Action on data field, select

Executing the Job

  1. Press F6 to execute the Job.

  2. The Run view console reads as

  3. Double-click the tTeradataTPump
    component to go back to its Component

  4. On the Advanced settings tab, select the
    Return tpump error check box and type
    in the exit code number to indicate the point at which an error message
    should be displayed in the console. In this example, enter the number
    4 and use the default values for the other

  5. Press F6 to run the Job.

  6. The Run view console reads as


    An exception error occurs and TPump returned exit code 12 is
    displayed. If you need to view detailed information about the exception
    error, you can open the log file stored in the directory you specified in
    the Error file field in the Basic settings tab of the Component view.

Document get from Talend
Thank you for watching.
Notify of
Inline Feedbacks
View all comments
Would love your thoughts, please comment.x