August 17, 2023

tSQLTemplateFilterRows – Docs for ESB 5.x



tSQLTemplateFilterRows Properties

Component family




tSQLTemplateFilterRows allows you
to define a row filter on one table. This component has real-time
capabilities since it runs the data filtering on the DBMS


Helps to set row filters for any given data source, based on a
WHERE clause.

Basic settings

Database Type

Select the type of database you want to work on from the drop down


Component List

Select the relevant DB connection component in the list if you are
using more than one connection in the current Job.


Database name

Name of the database.


Source table name

Name of the table holding the data you want to filter.


Target table name

Name of the table you want to write the filtered data in.


Schema and Edit

A schema is a row description, 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 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



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


Where condition

Use a WHERE clause to set the criteria that you want the rows to

You can use the WHERE clause to select specific rows from the
table that match specified criteria or conditions.

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


This component is used as an intermediary component with other DB
components, particularly DB connection 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 Scenario

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