July 30, 2023

tMysqlSP – Docs for ESB 7.x


Calls a MySQL database stored procedure.

tMysqlSP offers a convenient way to centralize multiple
or complex queries in a database and call them easily.

tMysqlSP Standard properties

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

The Standard
tMysqlSP component belongs to the Databases family.

The component in this framework is available in all Talend

Note: This component is a specific version of a dynamic database
connector. The properties related to database settings vary depending on your database
type selection. For more information about dynamic database connectors, see Dynamic database components.

Basic settings


Select a type of database from the list and click

Property type

Either Built-in or


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.


Database server IP address


Listening port number of DB server.


Name of the database

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.

Schema and Edit

A schema is a row description. It defines the number of fields
(columns) to be processed and passed on to the next component. When you create a Spark
Job, avoid the reserved word line when naming the


Built-In: You create and store the schema locally for this component


Repository: You have already created the schema and stored it in the
Repository. You can reuse it in various projects and Job designs.


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

SP Name

Type in the exact name of the Stored Procedure

Is Function / Return result

Select this check box, if a value only is to be returned.

Select on the list the schema column, the value to be returned is
based on.


Click the Plus button and select the various Schema Columns that will be required by the
procedures. Note that the SP schema can hold more columns than there
are paramaters used in the procedure.

Select the Type of

IN: Input parameter.

OUT: Output parameter/return

IN OUT: Input parameters is to be
returned as value, likely after modification through the procedure

RECORDSET: Input parameters is to
be returned as a set of values, rather than single value.


Check Inserting data in mother/daughter tables if you want to analyze a set of records from a
database table or DB query and return single records.


Usage rule

This component is used as intermediary component. It can be used
as start component but only input parameters are thus allowed.

Dynamic settings

Click the [+] button to add a row in the table
and fill the Code field with a context
variable to choose your database connection dynamically from multiple
connections planned in your Job. This feature is useful when you need to
access database tables having the same data structure but in different
databases, 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.


The Stored Procedures syntax should match the Database syntax.

Using tMysqlSP to find a State Label using a stored

The following job aims at finding the State labels matching the odd State
IDs in a Mysql two-column table. A stored procedure is used to carry out this operation.

  • Drag and drop the following components used in this example:
    tRowGenerator, tMysqlSP, tLogRow.

  • Connect the components using the Row

  • The tRowGenerator is used
    to generate the odd id number. Double-click on the component to launch the

  • Click on the Plus button to
    add a column to the schema to generate.

  • Select the Key check box
    and define the Type to Int.

  • The Length equals to 2
    digits max.

  • Use the preset function called sequence but customize the Parameters in the lower part of the

  • Change the Value of
    step from 1 to
    2 for this example, still starting from 1.

  • Set the Number of generated
    to 25 in order for all the odd State id (of 50 states) to
    be generated.

  • Click OK to validate the

  • Then select the tMysqlSP
    component and define its properties.

  • Set the Property type
    field to Repository and
    select the relevant entry on the list. The connection details get filled in

  • Else, set manually the connection information.

  • Click Sync Column to
    retrieve the generated schema from the preceding component.

  • Then click Edit Schema
    and add an extra column to hold the State Label to be output, in addition to the

  • Type in the name of the procedure in the SP Name field as it is called in the Database.
    In this example, getstate. The procedure to be executed
    states as follows:

  • In the Parameters area,
    click the plus button to add a line to the table.

  • Set the Column field to
    ID, and the Type field to IN as it will be given as
    input parameter to the procedure.

  • Add a second line and set the Column field to State and the Type to Out as this is
    the output parameter to be returned.

  • Eventually, set the tLogRow component properties.

  • Synchronize the schema with the preceding component.

  • And select the Print values in cells
    of a table
    check box for reading convenience.

  • Then save your Job and execute it.


The output shows the state labels corresponding to the odd state ids as
defined in the procedure.


Check Inserting data in mother/daughter tables if you want to analyze a set of records from a database table or DB query and
return single records.

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