August 17, 2023

tJDBCOutput – Docs for ESB 5.x

tJDBCOutput

tJDBCOutput_icon32_white.png

tJDBCOutput properties

Component family

Databases/JDBC

 

Function

tJDBCOutput writes, updates,
makes changes or suppresses entries in any type of database
connected to a JDBC API.

If you have subscribed to one of the Talend solutions with Big Data, you are
able to use this component in a Talend Map/Reduce Job or a Talend Storm Job:

Purpose

tJDBCOutput executes the action
defined on the data contained in the table, based on the flow
incoming from the preceding component in the Job.

Basic settings

Property type

Either Built-in or
Repository
.

 

 

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.

 

Use an existing connection

Select this check box and in the Component List click the
relevant connection component to reuse the connection details you already defined.

Note

When a Job contains the parent Job and the child Job, if you need to share an existing
connection between the two levels, for example, to share the connection created by the
parent Job with the child Job, you have to:

  1. In the parent level, register the database connection to be shared in the
    Basic settings view of the connection
    component which creates that very database connection.

  2. In the child level, use a dedicated connection component to read that
    registered database connection.

For an example about how to share a database connection across Job levels, see
Talend Studio User
Guide
.

 

Save_Icon.png

Click this icon to open a database connection wizard and store the
database connection parameters you set in the component Basic settings view.

For more information about setting up and storing database
connection parameters, see Talend Studio User Guide.

 

JDBC URL

Type in the database location path

 

Driver JAR

Click the plus button under the table to add lines of the count of
your need for the purpose of loading several JARs. Then on each
line, click the three dot button to open the [Select Module] wizard from which you can select a
driver JAR of your interest for each line.

 

Class Name

Type in the Class name to be pointed to in the driver.

 

Username and
Password

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

 

Table

Name of the table to be written. Note that only one table can be
written at a time

 

Action on data

On the data of the table defined, you can perform:

Insert: Add new entries to the
table. If duplicates are found, Job stops.

Update: Make changes to existing
entries

Insert or update: Insert a new record. If the record with
the given reference already exists, an update would be made.

Update or insert: Update the record with the given
reference. If the record does not exist, a new record would be inserted.

Delete: Remove entries
corresponding to the input flow.

Warning

It is necessary to specify at least one column as a
primary key on which the Update and Delete operations are
based. You can do that by clicking Edit Schema and selecting
the check box(es) next to the column(s) you want to set as
primary key(s). For an advanced use, click the Advanced
settings view where you can simultaneously define primary
keys for the Update and Delete operations. To do that:
Select the Use field options check box and then in the Key
in update column, select the check boxes next to the column
names you want to use as a base for the Update operation. Do
the same in the Key in delete column for the Delete
operation.

 

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.

 

 

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.

When the schema to be reused has default values that are integers or functions, ensure that
these default values are not enclosed within quotation marks. If they are, you must remove
the quotation marks manually.

For more details, see https://help.talend.com/display/KB/Verifying+default+values+in+a+retrieved+schema.

   

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.

 

Die on error

This check box is selected by default. Clear the check box to skip
the row on error and complete the process for error-free rows. If
needed, you can retrieve the rows on error via a Row > Rejects link.

 

Specify a data source alias

Select this check box and specify the alias of a data source created on the Talend Runtime side to use the shared connection pool defined in the data source configuration.
This option works only when you deploy and run your Job in Talend Runtime.

Warning

If you use the component’s own DB configuration, your data source connection will be
closed at the end of the component. To prevent this from happening, use a shared DB
connection with the data source alias specified.

This check box is not available when the Use an existing
connection
check box is selected.


Advanced settings

Commit every

Enter the number of rows to be completed before committing batches
of rows together into the database. This option ensures transaction
quality (but not rollback) and, above all, better performance at
execution.

 

Additional Columns

This option is not offered if you create (with or without drop)
the database table. This option allows you to call SQL functions to
perform actions on columns, which are not insert, nor update or
delete actions, or action that require particular preprocessing.

 

 

Name: Type in the name of the
schema column to be altered or inserted as new column

 

 

SQL expression: Type in the SQL
statement to be executed in order to alter or insert the relevant
column data.

 

 

Position: Select Before, Replace or After
following the action to be performed on the reference column.

 

 

Reference column: Type in a
column of reference that the tDBOutput can use to place or replace the new or
altered column.

 

Use field options

Select this check box to customize a request, especially when
there is double action on data.

 

Enable debug mode

Select this check box to display each step during processing
entries in a database.

 

Use Batch

Select this check box to activate the batch
mode for data processing.

 

Batch Size

Specify the number of records to be processed
in each batch. The default value for this field is 10000.

This field appears only when the Use Batch check box is selected.

 

tStat
Catcher Statistics

Select this check box to collect log data at the component
level.

 

Enable parallel execution

Select this check box to perform high-speed data processing, by treating multiple data flows
simultaneously. Note that this feature depends on the database or the application ability to
handle multiple inserts in parallel as well as the number of CPU affected. In the Number of parallel executions field, either:

  • Enter the number of parallel executions desired.

  • Press Ctrl + Space and select the appropriate
    context variable from the list. For further information, see Talend Studio
    User Guide
    .

Note that when parallel execution is enabled, it is not possible to use global variables to
retrieve return values in a subjob.

Warning

  • The Action on table
    field is not available with the parallelization function. Therefore, you
    must use a tCreateTable component if you
    want to create a table.

  • When parallel execution is enabled, it is not possible to use global
    variables to retrieve return values in a subjob.

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.

Global Variables 

NB_LINE: the number of rows processed. This is an After
variable and it returns an integer.

NB_LINE_UPDATED: the number of rows updated. This is an
After variable and it returns an integer.

NB_LINE_INSERTED: the number of rows inserted. This is an
After variable and it returns an integer.

NB_LINE_DELETED: the number of rows deleted. This is an
After variable and it returns an integer.

NB_LINE_REJECTED: the number of rows rejected. This is an
After variable and it returns an integer.

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 +
Space
to access the variable list and choose the variable to use from it.

For further information about variables, see Talend Studio
User Guide.

Usage

This component offers the flexibility benefit of the database
query and covers all of the SQL queries possible.

This component must be used as an output component. It allows you
to carry out actions on a table or on the data of a table in a JDBC
database. It also allows you to create a reject flow using a
Row > Rejects link to filter
data in error. For an example of tMySqlOutput in use, see Scenario 3: Retrieve data in error with a Reject link.

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.

tJDBCOutput in Talend Map/Reduce
Jobs

Warning

The information in this section is only for users that have subscribed to one of
the Talend solutions with Big Data and is not applicable to
Talend Open Studio for Big Data users.

In a Talend Map/Reduce Job, tJDBCOutput, as well as the other Map/Reduce components preceding it,
generates native Map/Reduce code. This section presents the specific properties of
tJDBCOutput when it is used in that situation. For
further information about a Talend Map/Reduce Job, see Talend Big Data Getting Started Guide.

Component family

MapReduce/Output

 

Function

tJDBCOutput writes entries in any
type of database connected to a JDBC API.

Basic settings

Property type

Either Built-in or
Repository
.

 

 

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.

 

Save_Icon.png

Click this icon to open a database connection wizard and store the
database connection parameters you set in the component Basic settings view.

For more information about setting up and storing database
connection parameters, see Talend Studio User Guide.

 

JDBC URL

Type in the database location path. For example, if a MySQL
database called Talend is hosted
by a machine located at an IP address XX.XX.XX.XX and the port is 3306, then the URL should be jdbc:mysql://XX.XX.XX.XX:3306/Talend.

 

Driver JAR

Click the [+] button under the
table to add lines of the count of your need for the purpose of
loading several JARs. Then on each line, click the […] button to open the [Select Module] wizard from which you can
select a driver JAR of your interest for each line.

 

Class Name

Type in the Class name to be pointed to in the driver. For
example, for the mysql-connector-java-5.1.2.jar driver, the name to
be entered is org.gjt.mm.mysql.Driver.

 

Username and
Password

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

 

Table name

Name of the table to be written. Note that this must exist and
only one table can be written at a time.

 

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.

   

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.

Advanced settings

Use Batch Size

When selected, enables you to define the number of lines in each
processed batch.

Usage

In a Talend Map/Reduce Job, it is used as an end component and requires
a transformation component as input link. The other components used along with it must be
Map/Reduce components, too. They generate native Map/Reduce code that can be executed
directly in Hadoop.

This component, along with the MapReduce family it belongs to, appears only when you are
creating a Map/Reduce Job.

Note that in this documentation, unless otherwise explicitly stated, a scenario presents
only Standard Jobs, that is to say traditional Talend data
integration Jobs, and non Map/Reduce Jobs.

Hadoop Connection

You need to use the Hadoop Configuration tab in the
Run view to define the connection to a given Hadoop
distribution for the whole Job.

This connection is effective on a per-Job basis.

Limitation

We recommend using the following databases with the Map/Reduce
version of this component: DB2, Informix, MSSQL, MySQL, Netezza,
Oracle, Postgres, Teradata and Vertica.

It may work with other databases as well, but these may not
necessarily have been tested.

tJDBCOutput in Talend Storm
Jobs

Warning

The information in this section is only for users that have subscribed to one of
the Talend solutions with Big Data and is not applicable to
Talend Open Studio for Big Data users.

In a Talend Storm Job, tJDBCOutput,
as well as the other Storm components preceding it, generates native Storm code to build
the Storm topology to be seamlessly used in your Storm ecosystem. This section presents
the specific properties of tJDBCOutput when it is used
in that situation. For further information about a Talend Storm Job, see
Talend Big Data Getting Started Guide.

Component family

Storm/Output

 

Function

tJDBCOutput writes entries in any
type of database connected to a JDBC API.

Basic settings

Property type

Either Built-in or
Repository
.

 

 

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.

 

Save_Icon.png

Click this icon to open a database connection wizard and store the
database connection parameters you set in the component Basic settings view.

For more information about setting up and storing database
connection parameters, see Talend Studio User Guide.

 

JDBC URL

Type in the database location path. For example, if a MySQL
database called Talend is hosted
by a machine located at an IP address XX.XX.XX.XX and the port is 3306, then the URL should be jdbc:mysql://XX.XX.XX.XX:3306/Talend.

 

Driver JAR

Click the [+] button under the
table to add lines of the count of your need for the purpose of
loading several JARs. Then on each line, click the […] button to open the [Select Module] wizard from which you can
select a driver JAR of your interest for each line.

 

Class Name

Type in the Class name to be pointed to in the driver. For
example, for the mysql-connector-java-5.1.2.jar driver, the name to
be entered is org.gjt.mm.mysql.Driver.

 

Username and
Password

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

 

Table name

Name of the table to be written. Note that this must exist and
only one table can be written at a time.

 

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.

   

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.

Usage

In a Talend Storm Job, it is used as an end component. The other
components used along with it must be Storm components, too. They generate native Storm code
that can be executed directly in a Storm system.

This component, along with the Storm family it belongs to, appears only when you are
creating a Storm Job.

Note that in this documentation, unless otherwise explicitly stated, a scenario presents
only Standard Jobs, that is to say traditional Talend data
integration Jobs.

Storm Connection

You need to use the Storm Configuration tab in the
Run view to define the connection to a given Storm
system for the whole Job.

This connection is effective on a per-Job basis.

Limitation

n/a

Related scenarios

For tJDBCOutput related topics, see:

If you are a subscription-based Big Data user, you can as well
consult a Talend Map/Reduce Job using the Map/Reduce version of
tJDBCOutput:


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