August 17, 2023

tDBOutput – Docs for ESB 5.x

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

tDBOutput

tDBOutput_icon32_white.png

tDBOutput properties

Component family

Databases/DB Generic

  

Function

tDBOutput writes, updates, makes
changes or suppresses entries in a database.

Note

To use this component, relevant DBMSs’ ODBC drivers should be
installed and the corresponding ODBC connections should be
configured via the database connection configuration
wizard.

Purpose

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

Note

Specific Output component should always be preferred to
generic component.

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.

 
Save_Icon.png

Click this icon to open the database connection configuration
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.

 

Database

Name of the data source defined via the database connection
configuration wizard.

 

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.

 

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.

 

Clear data in table

Select this check box to delete data in the selected table before
any 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.

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.

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.

Advanced settings

Additional JDBC parameters

Specify additional connection properties for the database
connection you are creating.

Note

You can set the encoding parameters through this field.
 

Commit every

Enter the number of rows to be completed before committing batches
of rows together into the DB. 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 DB 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
depending on 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 java.sql.Statement

Select this check box to use the Statement object in
case the PreparedStatement object is not supported by
certain DBMSs.

 

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

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.

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 DB 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 the data of a table in a database. It also
allows you to create a reject flow using a Row
> Rejects link to filter data in error. For a
related scenario, 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.

Scenario: Writing a row to a table in the MySQL database via an ODBC
connection

This scenario clears the data in a table of a MySQL database first and then adds a row
to it.

The table, named Date, contains one column called
date with the type being date.

Warning

As a prerequisite of this Job, the MySQL ODBC driver must
have been installed and the corresponding ODBC connection must have been
configured.

  1. Drop tDBOutput and tRowGenerator from the Palette
    to the design workspace.

  2. Connect the components using a Row >
    Main link.

    use_case_tdboutput_1.png

  3. Double-click tRowGenerator to open its
    Schema editor.

    use_case_tdboutput_2.png

  4. Click the [+] button to add a line.

    Enter date as the column name.

    Select Date from the data type list.

    Select getCurrentDate from the Functions list.

    Enter 1 in the Number
    of Rows for RowGenerator     field as only one row will be added to
    the table.

    Click OK to close the editor and propagate
    the schema changes to tDBOutput
    subsequently.

  5. Double-click tDBOutput to open its Basic settings view in the Component tab.

    use_case_tdboutput_3.png

  6. In the Database field, enter the name of the
    data source defined during the configuration of the MySql ODBC connection.

    To configure an ODBC connection, click Save_Icon.png to open the database connection configuration
    wizard.

  7. In the Username and Password fields, enter the database authentication
    credentials.

  8. In the Table field, enter the table name,
    Date in this example.

  9. In the Action on data field, select Insert to insert a line to the table.

  10. Select the check box Clear data in table to
    clear the table before the insertion.

  11. Save the Job and press F6 to run.

    use_case_tdboutput_4.png

    As shown above, the table now has only one line about the current date and
    time.

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