August 17, 2023

tSQLTemplate – Docs for ESB 5.x



tSQLTemplate properties

Component family




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


Helps users to conveniently execute the common database actions or customized SQL
statement templates, for example to drop/create a table. Note that
such templates are accessible via the SQL

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.

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

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



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.

SQL Template

SQL Template List

To add a default system SQL template:
Click the Add button to
add the default system SQL template(s) in the SQL Template List.

Click in the SQL template field and then click the arrow to
display the system SQL template list. Select the desired system SQL
template provided by Talend.

Note: You can create your own SQL
template and add them to the SQL Template

To create a user-defined SQL

-Select a system template from the SQL
Template list
and click on its code in the code box.
You will be prompted by the system to create a new template.

-Click Yes to open the SQL
template wizard.

-Define your new SQL template in the corresponding fields and
click Finish to close the wizard.
An SQL template editor opens where you can enter the template

-Click the Add button to add the
new created template to the SQL Template

For more information, see Talend Studio User

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 connection 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 more information on Dynamic settings and context
variables, see Talend Studio User Guide.

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 SQL 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.


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


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

Related scenarios

For a related scenario, see Scenario: Filtering and aggregating table columns directly on the DBMS.

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