tRedshiftOutput Standard properties - Cloud

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

The Standard tRedshiftOutput component belongs to the Cloud and the Databases families.

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

Note: This component is a specific version of a dynamic database connector. The properties related to database settings vary depending on your database type selection. For more information about dynamic database connectors, see DB Generic components.

Basic settings

Database	Select the desired database type from the list and click Apply.
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.
	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 Centralizing database metadata.
Use an existing connection	Select this check box and in the Component List drop-down list, select the desired connection component to reuse the connection details you already defined. Note: When a Job contains the parent Job and the child Job, do the following if you want to share an existing connection between the parent Job and the child Job (for example, to share the connection created by the parent Job with the child Job). 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. 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 Sharing a database connection.
Driver version	Select the Redshift driver version to be used: Driver v1 or Driver v2. Note: This option is available only when you have installed the 8.0.1-R2022-04 Talend Studio Monthly update or a later one delivered by Talend. For more information, check with your administrator.
Host	Hostname or IP address of the database server.
Port	Listening port number of the database server.
Database	Database name. The bucket and the Redshift database to be used must be in the same region on Amazon. This could avoid the S3ServiceException errors known to Amazon. For further information about these errors, see S3ServiceException Errors.
Schema	Exact name of the schema.
Username and Password	Database user authentication data. To enter the password, click the [...] button next to the password field, enter the password in double quotes in the pop-up dialog box, and click OK to save the settings.
Use String JDBC parameters	Set JDBC properties in a string. If you select this option, enter your JDBC parameter string in the Additional JDBC Parameters field; otherwise, enter JDBC properties and property values in the Additional JDBC Parameters table. This option is not available if Driver v1 is selected from the Driver version drop-down list. Note: This option is available only when you have installed the 8.0.1-R2022-04 Talend Studio Monthly update or a later one delivered by Talend. For more information, check with your administrator.
Additional JDBC Parameters	Specify additional JDBC properties for the connection you are creating. The properties are separated by ampersand & and each property is a key-value pair. For example, ssl=true & sslfactory=com.amazon.redshift.ssl.NonValidatingFactory, which means the connection will be created using SSL. This field is not available if Driver v2 is selected from the Driver version drop-down list and the Use String JDBC parameters option is not selected.
Additional JDBC Parameters (table)	Specify JDBC properties in table rows. To specify a JDBC property, add a row in the table by clicking the plus button on the bottom of this table, enter the property name in the Key column, and then enter the property value in the Value column. This table is available when Driver v2 is selected from the Driver version drop-down list and the Use String JDBC parameters option is not selected. Note: This option is available only when you have installed the 8.0.1-R2022-04 Talend Studio Monthly update or a later one delivered by Talend. For more information, check with your administrator.
Table	Name of the table to which the data will 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 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, the operation will stop. Update: Make changes to existing entries. Note: In cases where all the schema columns are set as keys, this action yields an error and the Job fails. Insert or update: Insert a new record. If the record with the given reference already exists, an update would be made. Note: In cases where all the schema columns are set as keys, this action yields a warning message and the Job continues. Update or insert: Update the record with the given reference. If the record does not exist, a new record would be inserted. Note: In cases where all the schema columns are set as keys, this action yields a warning message and the Job continues. 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. When you create a Spark Job, avoid the reserved word `line` when naming the fields. 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 Dynamic schema. 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. Repository: You have already created the schema and stored it in the Repository. You can reuse it in various projects and Job designs. 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 information, see Retrieving table schemas. 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 through a Row>Rejects link.

Advanced settings

Use alternate schema	Select this option to use a schema other than the one specified by the component that establishes the database connection (that is, the component selected from the Component list drop-down list in Basic settings view). After selecting this option, provide the name of the desired schema in the Schema field. This option is available when Use an existing connection is selected in Basic settings view.
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. 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. Amazon Redshift requires the number of rows per insert to be less than 32767. For this reason, if the number you enter exceeds this maximum limit, Talend Studio automatically resets this number below this limit. 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.
Use Batch	Select this check box to activate the batch mode for data processing. Note: This check box is available only when you have selected the Update or the Delete option in the Action on data field.
Batch Size	Specify the number of records to be processed in each batch. This field appears only when the Use batch mode check box is selected.
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 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.
Support null in "SQL WHERE" statement	Select this check box to validate null in "SQL WHERE" statement.
Table name include schema	Select this check box to specify the schema along with the table in the Table field in the Basic settings view. With this check box selected, you can specify both the schema and the table in the Table field in the format of `yourSchema.yourTable`; and the Job will try to locate `yourTable` in `yourSchema`.
JDBC url	Select a way to access to an Amazon Redshift database from the JDBC url drop-down list. Standard: Use the standard way to access the Redshift database. SSO: Use the IAM Single Sign-ON (SSO) authentication way to access the Redshift Database. Before selecting this option, ensure that the IAM role added to your Redshift cluster has appropriate access rights and permissions to this cluster. You can ask the administrator of your AWS services for more details. This option is available only when Use an existing connection check box is not selected from the Basic settings.
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 about context variables, see Using contexts and variables. 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.

Note: The Row > Reject link is not available if any of these three options is selected: Die on error, Extend Insert, and Use Batch. Also, to make sure your Job runs properly, do not select any of these three options with the presence of the Row > Reject link.

Global Variables

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 more information about variables, see Using contexts and 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 more information about variables, see Using contexts and variables.

Usage

Usage rule	This component covers all possible SQL database queries. It allows you to carry out actions on a table or on the data of a table in an Amazon Redshift database. It enables you to create a reject flow, with a Row>Rejects link filtering the data in error. For a usage example, see Retrieving data in error with a Reject link.
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 Reading data from databases through context-based dynamic connections and Reading data from different MySQL databases using dynamically loaded connection parameters. For more information on Dynamic settings and context variables, see Dynamic schema and Creating a context group and define context variables in it.
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 Talend Studio. For details, see Installing external modules.

Usage rule

This component covers all possible SQL database queries. It allows you to carry out actions on a table or on the data of a table in an Amazon Redshift database. It enables you to create a reject flow, with a Row>Rejects link filtering the data in error. For a usage example, see Retrieving data in error with a Reject link.

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 Reading data from databases through context-based dynamic connections and Reading data from different MySQL databases using dynamically loaded connection parameters. For more information on Dynamic settings and context variables, see Dynamic schema and Creating a context group and define context variables in it.

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 Talend Studio. For details, see Installing external modules.