July 30, 2023

tSQLTemplate – Docs for ESB 7.x


Executes the common database actions or customized SQL statement templates, for
example to drop/create a table.

tSQLTemplate offers a range of SQL
statement templates for a number of DBMSs to facilitate some of the most common database
actions. These templates are accessible via the SQL
view. Additionally, you are allowed to customize the SQL statement
templates as needed.

tSQLTemplate Standard properties

These properties are used to configure tSQLTemplate running in the Standard Job framework.

The Standard
tSQLTemplate component belongs to the ELT family.

The component in this framework is available in all Talend

Basic settings

Database Type

Select the database type you want to connect to from the

Component List

Select the relevant database connection component in the list if you use more than one
connection in the current Job.

Database name

Name of the database.

Table name

Name of the table on which the SQL statement templates will be executed.

Schema and Edit

A schema is a row description, that is to say, it defines the number of fields that
will be processed and passed on to the next component. The schema is
either built-in or remote in the Repository.

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

  • 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 changes.

  • 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 Content


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 flowcharts. Related topic: see
Talend Studio User Guide

Advanced settings

tStatCatcher Statistics

Select this check box to gather the Job processing metadata at a
Job level as well as at each component level.

Global Variables

Global Variables

NB_LINE: the number of rows read by an input component or
transferred to an output component. This is an After variable and it returns an

QUERY: the query statement being processed. This is a Flow
variable and it returns a string.

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.


Usage rule

As a start component, this component is used with other database components, especially
the database connection and commit components.

SQL Template

SQL Template List

Dynamic settings

Click the [+] button to add a row in the
table and fill the Code field with a context variable
to choose your HDFS connection dynamically from multiple connections planned in your
Job. This feature is useful when you need to access files in different HDFS systems or
different distributions, especially when you are working in an environment where you
cannot change your Job settings, for example, when your Job has to be deployed and
executed independent of
Talend Studio

The Dynamic settings table is
available only when the Use an existing
check box is selected in the Basic settings view. Once a dynamic parameter is
defined, the Component List box in the
Basic settings view becomes unusable.

For examples on using dynamic parameters, see Reading data from databases through context-based dynamic connections and Reading data from different MySQL databases using dynamically loaded connection parameters. For more information on Dynamic
and context variables, see Talend Studio
User Guide.

Related scenarios

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