August 17, 2023

tMysqlSP – Docs for ESB 5.x

  2. Talend for ESB Docs
  3. Docs 5.x
  4. tMysqlSP – Docs for ESB 5.x

tMysqlSP

tMysqlSP_icon32_white.png

tMysqlSP Properties

Component family

Databases/Mysql

  

Function

tMysqlSP calls the database
stored procedure.

Purpose

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

Basic settings

Property type

Either Built-in or
Repository.

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

 

 

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

 

Host

Database server IP address

 

Port

Listening port number of DB server.

 

Database

Name of the database

 

Username and
Password

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
Schema

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

 

SP Name

Type in the exact name of the Stored Procedure

 

Is Function / Return result
in

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.

 

Parameters

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
parameter:

IN: Input parameter.

OUT: Output parameter/return
value.

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

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

Note

Check Scenario 1: 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.

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

Usage

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

Log4j

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

For more information on the log4j logging levels, see the Apache documentation at http://logging.apache.org/log4j/1.2/apidocs/org/apache/log4j/Level.html.

Limitation

The Stored Procedures syntax should match the Database syntax.

Scenario: Finding a State Label using a stored procedure

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.

Use_Case_tMysqlSP1.png

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

  • Connect the components using the Row Main
    link.

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

Use_Case_tMysqlSP2.png

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

Use_Case_tMysqlSP2.png

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

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

  • Click OK to validate the
    configuration.

  • Then select the tMysqlSP component and
    define its properties.

Use_Case_tMysqlSP3.png

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

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

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

Use_Case_tMysqlSP4.png

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

Use_Case_tMysqlSP5.png

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

Note

Check Scenario 1: 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.
Docs 5.x
Subscribe
Notify of
guest
0 Comments
Inline Feedbacks
View all comments
0
Would love your thoughts, please comment.x
()
x