tHSQLDbOutput Standard properties - 6.4

HSQLDB

author
Talend Documentation Team
EnrichVersion
6.4
EnrichProdName
Talend Big Data
Talend Big Data Platform
Talend Data Fabric
Talend Data Integration
Talend Data Management Platform
Talend Data Services Platform
Talend ESB
Talend MDM Platform
Talend Open Studio for Big Data
Talend Open Studio for Data Integration
Talend Open Studio for ESB
Talend Open Studio for MDM
Talend Real-Time Big Data Platform
task
Data Governance > Third-party systems > Database components > HSQLDB components
Data Quality and Preparation > Third-party systems > Database components > HSQLDB components
Design and Development > Third-party systems > Database components > HSQLDB components
EnrichPlatform
Talend Studio

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

The Standard tHSQLDbOutput component belongs to the Databases family.

The component in this framework is available in all Talend products.

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.

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.

Running Mode

Select on the list the Server Mode corresponding to your DB setupamong the four propositions :

HSQLDb Server, HSQLDb WebServer, HSQLDb In Process Persistent, HSQLDb In Memory.

Use TLS/SSL sockets

Select this check box to enable the secured mode if required.

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.

DB path

Specify the directory to the database you want to connect to. This field is available only to the HSQLDb In Process Persistent running mode.

Note:

By default, if the database you specify in this field does not exist, it will be created automatically. If you want to change this default set­ting, modify the connection parameter set in the Additional JDBC parameter field in the Advanced settings view

Db name

Enter the database name that you want to connect to. This field is available only to the HSQLDb In Process Persistent running mode and the HSQLDb In Memory running mode.

Table

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

Action on table

On the table defined, you can perform one of the following operations:

None: No operation is carried out.

Drop and create a table: The table is removed and created again.

Create a table: The table does not exist and gets created.

Create a table if not exists: The table is created if it does not exist.

Drop a table if exists and create: The table is removed if it already exists and created again.

Clear a table: The table content is deleted.

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 (columns) 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.

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.

 

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 Verifying default values in a retrieved schema.

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 DB connection you are creating. When the running mode is HSQLDb In Process Persistent , you can set the connection property ifexists=true to allow connection to an existing database only and avoid creating a new database.

Note:

You can press Ctrl+Space to access a list of predefined global variables.

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

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.

  • 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

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

QUERY: the query statement processed. This is an After variable and it returns a string.

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.

A Flow variable functions during the execution of a component while an After variable functions after the execution of the component.

Usage

Usage rule

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 a table or on the data of a table in a MySQL 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 Retrieving data in error with a Reject link.

Connections

Outgoing links (from this component to another):

Row: Main; Reject

Trigger: Run if; On Component Ok; On Component Error; On Subjob Ok; On Subjob Error.

Incoming links (from one component to this one):

Row: Main;

Trigger: Run if; On Component Ok; On Component Error; On Subjob Ok; On Subjob Error.

For further information regarding connections, see Talend Studio User Guide.

Limitation

Due to license incompatibility, one or more JARs required to use this component are not provided. You can install the missing JARs for this particular component by clicking the Install button on the Component tab view. You can also find out and add all missing JARs easily on the Modules tab in the Integration perspective of your studio. For details, see Installing external modules.