tAmazonAuroraOutput - 6.1

Talend Components Reference Guide

EnrichVersion
6.1
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 Data Quality
Talend Open Studio for ESB
Talend Open Studio for MDM
Talend Real-Time Big Data Platform
task
Data Governance
Data Quality and Preparation
Design and Development
EnrichPlatform
Talend Studio

Function

This component writes, updates, makes changes or suppresses entries in an Amazon Aurora database.

Purpose

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

tAmazonAuroraOutput properties

Component family

Cloud/AmazonRDS/Aurora

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

 

Host

Type in the IP address or hostname of the Amazon Aurora database.

 

Port

Type in the listening port number of the Amazon Aurora database.

 

Database

Type in the name of the database you want to use.

 

Username and Password

Type in the 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

Type in the 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.

  • Truncate table: The table content is quickly deleted. However, you will not be able to rollback the operation.

 

Action on data

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

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

  • Replace: Add new entries to the table. If an old row in the table has the same value as a new row for a PRIMARY KEY or a UNIQUE index, the old row is deleted before the new row is inserted.

  • Insert or update on duplicate key or unique index: Add entries if the inserted value does not exist or update entries if the inserted value already exists and there is a risk of violating a unique index or primary key.

  • Insert Ignore: Add only new rows to prevent duplicate key errors.

Warning

You must 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 name on which you want to base the update operation. Do the same in the Key in delete column for the deletion operation.

Note

The dynamic schema feature can be used in the following modes: Insert, Update, Insert or update, Update or insert, Delete.

 

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.

This component offers the advantage of the dynamic schema feature. This allows you to retrieve unknown columns from source files or to copy batches of columns from a source without mapping each column individually. For further information about dynamic schemas, see Talend Studio User Guide.

This dynamic schema feature is designed for the purpose of retrieving unknown columns of a table and is recommended to be used for this purpose only; it is not recommended for the use of creating tables.

 

 

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.

 

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.

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

 

Data source alias

Type in the alias of the data source created on the Talend Runtime side.

This field appears only when the Specify a data source alias check box is selected.

 

Die on error

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

Advanced settings

Additional JDBC parameters

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

This field disappears when the Use an existing connection check box in the Basic settings view is selected.

Note

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

 

Extend Insert

Select this check box to carry out a bulk insert of a defined set of lines instead of inserting lines one by one. The gain in system performance is considerable.

This check box appears only when the Insert option is selected from the Action on data list in the Basic settings view.

Note

This option is not compatible with the Reject link. You should therefore clear the check box if you are using a Row > Rejects link with this component.

 

Number of rows per insert

Enter the number of rows to be inserted per operation. Note that the higher the value specified, the lower performance levels shall be due to the increase in memory demands.

This field appears only when the Extend Insert check box is selected.

 

Use Batch

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

This check box is available only when the Update or Delete option is selected from the Action on data list in the Basic settings view.

 

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.

 

Commit every

Enter the number of rows to be included in a batch before it is committed to the database. This option ensures transaction quality (but not rollback) and, above all, a higher performance level.

 

Additional columns

This option allows you to call SQL functions to perform actions on columns, provided that these are not insert, update or delete actions, or actions that require pre-processing. This option is not available if you have just created the database table (even if you delete it beforehand). Click the [+] button under the table to add column(s), and set the following parameters for each column.

  • Name: Type in the name of the schema column to be altered or inserted.

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

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

  • Reference column: Type in a reference column that tAmazonAuroraOutput can use to locate or replace the new column or the column to be modified.

 

Use field options

Select the check box for the corresponding column to customize a request, particularly if multiple actions are being carried out on the data.

  • Key in update: Select the check box for the corresponding column based on which the data is updated.

  • Key in delete: Select the check box for the corresponding column based on which the data is deleted.

  • Updatable: Select the check box if the data in the corresponding column can be updated.

  • Insertable: Select the check box if the data in the corresponding column can be inserted.

 

Use Hint Options

Select this check box to configure the hint(s) which can help you optimize a query's execution.

 

Hint Options

Click the [+] button under the table to add hint(s) and set the following parameters for each hint. This table appears only when the Use Hint Options check box is selected.

  • HINT: Specify the hint you need, using the syntax /*+ */.

  • POSITION: Specify where you put the hint in an SQL statement.

  • SQL STMT*: Select an SQL statement INSERT, UPDATE, or DELETE you need to use.

 

Enable debug mode

Select this check box to display each step involved in the process of writing data in the database.

 

Use duplicate key update mode insert

Select this check box to activate the ON DUPLICATE KEY UPDATE mode, and then click the [+] button under the table displayed to add column(s) to be updated and specify the update action to be performed on the corresponding column.

  • Column: Enter the name of the column to be updated.

  • Value: Enter the action to be performed on the column.

This check box is available only when the Insert option is selected from the Action on data list in the Basic settings view.

 

tStatCatcher Statistics

Select this check box to gather the Job processing metadata at the Job level as well as at each 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 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.

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 used as an output component. It allows you to carry out actions on a table or on the data of a table in an Amazon Aurora database. It also allows you to create a reject flow using a Row > Rejects link to filter data in error. For a similar scenario, see Scenario 3: Retrieve data in error with a Reject link.

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 scenario

For a related scenario, see Scenario: Handling data with Amazon Aurora.