Select a type of database 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
Talend Studio User
Guide.

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.

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, and then in the pop-up dialog box enter the password between double quotes
and click OK to save the settings.

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.

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.

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.

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

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.

You can find more details about how to
verify default values in retrieved schema in 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 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.

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, the Studio
automatically resets this number below this limit.

Use Batch

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

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.

tStat
Catcher Statistics

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

Enable parallel execution

Note that 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 rule

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 Talend Studio
User Guide.

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. You can find more details about how to install external modules in
Talend Help Center (https://help.talend.com).

Property type

Either Built-In or Repository.

Built-In: No property data stored centrally.

Repository: Select the repository file where the
properties are stored.

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.

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.

Host

Enter the endpoint of the database you need to connect to in
Redshift.

Port

Enter the port number of the database you need to connect to in
Redshift.

The related information can be found in the Cluster Database
Properties area in the Web console of your Redshift.

For further information, see Managing clusters console.

Username and Password

Enter the authentication information to the Redshift database you
need to connect to.

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.

Database

Enter the name of the database you need to connect to in
Redshift.

The related information can be found in the Cluster Database
Properties area in the Web console of your Redshift.

For further information, see Managing clusters console.

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

Enter the name of the database schema to be used in Redshift. The
default schema is called PUBLIC.

A schema in terms of Redshift is similar to a operating system
directory. For further information about a Redshift schema, see Schemas.

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.

S3 configuration

Select the tS3Configuration component from which you want Spark to use the
configuration details to connect to S3.

You need drop the tS3Configuration component to be used alongside
tRedshiftConfiguration in
the same Job so that this tS3Configuration is displayed on the S3 configuration list.

S3 temp path

Enter the location in S3 in which the data to be
transferred from or to Redshift is temporarily stored.

This path is independent of the temporary path you need
to set in the Basic settings
tab of tS3Configuration.

Table

Enter the name of the table to which the data will be written.
Note that only one table can be written at a time.

If this table does not exist, you need to select Create from the Save mode list to allow tRedshiftOutput to create it.

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.

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.

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.

Save mode

Select the actions you want tRedshiftOutput to perform on the specified table.

• Create: tRedshiftOutput creates the specified table
  and writes data in this table.

• Append: tRedshiftOutput appends data to an existing
  table.

• Overwrite: tRedshiftOutput overwrites the data of the
  specified table.

  This overwrite impacts the availability of the target
  table. For this reason, if you need to keep this table highly available, you need to
  select the Use staging table check
  box in the Advanced settings tab
  to make tRedshiftOutput create and
  write data in a staging table and upon the success of this write, replace the target table
  with the staging one. With the staging table enabled, in case the write fails, the target
  table can be quickly restored.

Distribution style

Select the distribution style to be applied by tRedshiftOutput on the data to be written.

For further information about each of the distribution style, see
Distribution styles.

Define sort key

Select this check box to sort the data to be written based on
given columns of the data.

Once selecting it, you need to select the column(s) to be used as
the key(s) of the sort. For further information about the different type of sort keys, see
Choosing sort keys.

Use staging table

Select the Use staging
table check box to make tRedshiftOutput create and write data in a staging table and upon the success
of this write, replace the target table with the staging one.

This feature is available only when you have selected Overwrite from the Save mode list and is recommended when you need to keep the
target table of the overwrite highly available.

Define pre-actions

Select this check box and in the field that is displayed, add a
semicolon-separated(;) list of SQL statements that are executed before tRedshiftOutput starts to write data.

Define post-actions

Select this check box and in the field that is displayed, add a
semicolon-separated(;) list of SQL statements that are executed after tRedshiftOutput has successfully written data.

Define extra copy options

Select this check box and in the field that is displayed, add a
semicolon-separated(;) list of SQL statements that are executed along with the write of the
data.

tRedshiftOutput uses the Copy statement of
Redshift SQL to write data. The list of SQL statements you add here is actually appended to
the Copy statement and so only the statements that make sense at the end of this Copy command
should be used. For example, COMPUPDATE that is used to control whether compression encodings
are automatically applied during the execution of a Copy.

For further information about the extra options you can choose,
see Optional parameters.

Select the check box to output dates, hours, minutes and seconds contained in your
Date-type data. If you clear this check box, only years, months and days are
outputted.

The format used by Deltalake is yyyy-MM-dd HH:mm:ss.

Usage rule

This component is used as an end component and requires an input link.

This component should use a tRedshiftConfiguration component present in the same Job to
connect to Redshift. You need to drop a tRedshiftConfiguration component alongside this component and configure the
Basic settings of this component to use
tRedshiftConfiguration.

This component, along with the Spark Batch component Palette it belongs to,
appears only when you are creating a Spark Batch Job.

Note that in this documentation, unless otherwise explicitly stated, a
scenario presents only Standard Jobs, that is to
say traditional
Talend
data integration Jobs.

Spark Connection

This connection is effective on a per-Job basis.

Property type

Either Built-In or Repository.

Built-In: No property data stored centrally.

Repository: Select the repository file where the
properties are stored.

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.

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.

Host

Enter the endpoint of the database you need to connect to in
Redshift.

Port

Enter the port number of the database you need to connect to in
Redshift.

The related information can be found in the Cluster Database
Properties area in the Web console of your Redshift.

For further information, see Managing clusters console.

Username and Password

Enter the authentication information to the Redshift database you
need to connect to.

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.

Database

Enter the name of the database you need to connect to in
Redshift.

The related information can be found in the Cluster Database
Properties area in the Web console of your Redshift.

For further information, see Managing clusters console.

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

Enter the name of the database schema to be used in Redshift. The
default schema is called PUBLIC.

A schema in terms of Redshift is similar to a operating system
directory. For further information about a Redshift schema, see Schemas.

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.

S3 configuration

Select the tS3Configuration component from which you want Spark to use the
configuration details to connect to S3.

You need drop the tS3Configuration component to be used alongside
tRedshiftConfiguration in
the same Job so that this tS3Configuration is displayed on the S3 configuration list.

S3 temp path

Enter the location in S3 in which the data to be
transferred from or to Redshift is temporarily stored.

This path is independent of the temporary path you need
to set in the Basic settings
tab of tS3Configuration.

Table

Enter the name of the table to which the data will be written.
Note that only one table can be written at a time.

If this table does not exist, you need to select Create from the Save mode list to allow tRedshiftOutput to create it.

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.

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.

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.

Save mode

Select the actions you want tRedshiftOutput to perform on the specified table.

• Create: tRedshiftOutput creates the specified table
  and writes data in this table.

• Append: tRedshiftOutput appends data to an existing
  table.

• Overwrite: tRedshiftOutput overwrites the data of the
  specified table.

  This overwrite impacts the availability of the target
  table. For this reason, if you need to keep this table highly available, you need to
  select the Use staging table check
  box in the Advanced settings tab
  to make tRedshiftOutput create and
  write data in a staging table and upon the success of this write, replace the target table
  with the staging one. With the staging table enabled, in case the write fails, the target
  table can be quickly restored.

Distribution style

Select the distribution style to be applied by tRedshiftOutput on the data to be written.

For further information about each of the distribution style, see
Distribution styles.

Define sort key

Select this check box to sort the data to be written based on
given columns of the data.

Once selecting it, you need to select the column(s) to be used as
the key(s) of the sort. For further information about the different type of sort keys, see
Choosing sort keys.

Use staging table

Select the Use staging
table check box to make tRedshiftOutput create and write data in a staging table and upon the success
of this write, replace the target table with the staging one.

This feature is available only when you have selected Overwrite from the Save mode list and is recommended when you need to keep the
target table of the overwrite highly available.

Define pre-actions

Select this check box and in the field that is displayed, add a
semicolon-separated(;) list of SQL statements that are executed before tRedshiftOutput starts to write data.

Define post-actions

Select this check box and in the field that is displayed, add a
semicolon-separated(;) list of SQL statements that are executed after tRedshiftOutput has successfully written data.

Define extra copy options

Select this check box and in the field that is displayed, add a
semicolon-separated(;) list of SQL statements that are executed along with the write of the
data.

tRedshiftOutput uses the Copy statement of
Redshift SQL to write data. The list of SQL statements you add here is actually appended to
the Copy statement and so only the statements that make sense at the end of this Copy command
should be used. For example, COMPUPDATE that is used to control whether compression encodings
are automatically applied during the execution of a Copy.

For further information about the extra options you can choose,
see Optional parameters.

Select the check box to output dates, hours, minutes and seconds contained in your
Date-type data. If you clear this check box, only years, months and days are
outputted.

The format used by Deltalake is yyyy-MM-dd HH:mm:ss.

Usage rule

This component is used as an end component and requires an input link.

This component should use a tRedshiftConfiguration component present in the same Job to
connect to Redshift. You need to drop a tRedshiftConfiguration component alongside this component and configure the
Basic settings of this component to use
tRedshiftConfiguration.

This component, along with the Spark Streaming component Palette it belongs to, appears
only when you are creating a Spark Streaming Job.

Note that in this documentation, unless otherwise explicitly stated, a scenario presents
only Standard Jobs, that is to say traditional
Talend
data
integration Jobs.

Spark Connection

This connection is effective on a per-Job basis.