tSAPHanaOutput - 6.3

Talend Open Studio for Big Data Components Reference Guide

EnrichVersion
6.3
EnrichProdName
Talend Open Studio for Big Data
task
Data Governance
Data Quality and Preparation
Design and Development
EnrichPlatform
Talend Studio

Function

tSAPHanaOutput writes, updates, makes changes or suppresses entries in a SAP Hana database.

Purpose

tSAPHanaOutput executes the action defined on the table and/or on the data contained in the table, based on the flow incoming from the preceding component in the Job.

tSAPHanaOutput Properties

Component family

Databases / SAP Hana

 

Basic settings

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.

 

DB Version

Select the SAP Hana Database (HDB) version you are using.

 

Host

Database server IP address.

 

Port

Listening port number of database server.

 

Table Schema

Name of the database schema.

 

Username and Password

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

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

None: No operation is carried out.

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

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

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

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

Clear table: The table content is deleted.

Type of table storage

This option is only available if you create (with or without drop) the database table. This option allows you to define the way the data is stored in the table. The following types of table storage organization are available:

  • Row: Data is stored in rows. It is preferable to use this table type if the majority of table access involves selecting a few records, with all attributes selected.

  • Column: Data is stored in columns. It is preferable to use this table type if the majority of table access will be through a large number of tuples, with only a few selected attributes.

  • History column: Creates a table with a particular transaction session type called HISTORY. Tables with session type HISTORY support time travel queries. For more information on HISTORY and time travel queries, see http://help.sap.com/saphelp_hanaplatform/helpdata/en/20/d56cd075191014b7ea9e4e77477aae/content.htm.

  • Global temporary: The table definition and data can be seen by any user and any connection during the current session. The table is truncated at the end of the session.

  • Local temporary: The table definition and data can only be seen by the user who created the table during the current session. The table is truncated at the end of the session.

 

Action on data

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

Insert: Add new entries to the table. If duplicates are found, the 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, see Use filed options in the Advanced settings view.

 

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.

 

 

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 the article Verifying default values in a retrieved schema on Talend Help Center (https://help.talend.com).

  

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 cleared by default. This means that Die on error skips the row when an error is encountered and completes the process for rows without errors.

Advanced settings

Additional JDBC Parameters

Specify additional connection properties in the database connection you are creating. This option is not available if you have selected Use an existing connection check box in the Basic 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 available 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 any other action that requires 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 tSAPHanaOutput can use to locate or replace the new column or the column to be modified.

 

Use field options

Select this check box to customize a request, especially when there is double action on data. In that table, you can define:

Key in update: define the primary key to use in an update operation.

Key in delete: define the primary key to use in a delete operation.

Updatable: define the column(s) to update.

Insertable: define the column(s) to insert.

 

Enable debug mode

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

 

Support null in "SQL WHERE" statement

Select this check box to validate null in "SQL WHERE" statement.

 

Use Batch Size

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

Warning

This option is available only when you do not Use an existing connection in Basic settings.

 

tStatCatcher Statistics

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

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 examples on using dynamic parameters, see Scenario 3: Reading data from MySQL databases through context-based dynamic connections and Scenario: Reading data from different MySQL databases using dynamically loaded connection parameters. 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.

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

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 must be connected to an Input component. It allows you to carry out actions on a table or on the data of a table in an SAP Hana database. It also allows you to create reject flows using a Row > Reject link to filter erroneous data.

Log4j

If you are using a subscription-based version of the Studio, 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.

Related scenarios

No scenario is available for this component yet.