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

Host

Type in the IP address or hostname of the database server.

Port

Type in the listening port number of the database server.

Database

Type in the name of the database.

Schema

Type in the name of the schema.

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.

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

Type in the name of the table from which the data will be
read.

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.

Query Type and Query

Enter the database query paying particularly attention to the
proper sequence of the fields in order to match the schema definition.

Guess Query

Click the button to generate the query which corresponds to
the table schema in the Query
field.

Select this check box and in the Component List click the relevant connection component to
reuse the connection details you already defined.

Access Key

Specify the Access Key ID that uniquely identifies an AWS
Account. For how to get your Access Key and Access Secret, visit Getting Your AWS Access Keys.

This option is not available if Use an existing S3
connection is selected.

Secret Key

Specify the Secret Access Key, constituting the security
credentials in combination with the access Key.

To enter the secret key, click the […] button next to
the secret key field, and then in the pop-up dialog box enter the password between double
quotes and click OK to save the settings.

This option is not available if Use an existing S3
connection is selected.

Assume Role

Select this check box and specify the
values for the following parameters used to create a new assumed role session.

• IAM Role ARNs chains: a series of chained roles, which
  may belong to other accounts, that your cluster can assume to access resources.

  You
  can chain a maximum of 10 roles.

• Role ARN: the Amazon Resource Name (ARN) of the role
  to assume.

This option is not available if Use an existing S3
connection is selected.

For more information on IAM Role ARNs
chains, see Authorizing Redshift service.

Bucket

Type in the name of the Amazon S3 bucket, namely the top level
folder, to which the data is unloaded.

Key prefix

Type in the name prefix for the unload files on Amazon S3. By
default, the unload files are written per slice of the Redshift cluster and the
file names are written in the format <object_path>/<name_prefix><slice-number>_part_<file-number>.

File type

Select the type of the unload files on Amazon S3 from the
list:

• Delimited file or CSV: a
  delimited/CSV file.

• Fixed width: a fixed-width
  file.

Fields terminated by

Enter the character used to separate fields.

This field appears only when Delimited file or CSV is selected from the File type list.

Enclosed by

Select the character in a pair of which the fields are
enclosed.

This list appears only when Delimited file or CSV is selected from the File type list.

Fixed width mapping

Enter a string that specifies a user-defined column label and
column width between double quotation marks. The format of the string is:

ColumnLabel1:ColumnWidth1,ColumnLabel2:ColumnWidth2,....

Note that the column label in the string has no relation to
the table column name and it can be either a text string or an integer. The
order of the label/width pairs must match the order of the table columns
exactly.

This field appears only when Fixed
width is selected from the File
type list.

Compressed by

Select this check box and from the list displayed select the
compression type of the files.

Encrypt

Select this check box to encrypt unload file(s) using Amazon
S3 client-side encryption. In the Encryption
key field displayed, enter the encryption key used to encrypt
the unload file(s).

Note that only a base64 encoded AES 128-bit or AES 256-bit
envelope key is supported. For more information, see Unloading Encrypted Data Files.

This option is not available if Use an existing S3 connection is selected.

Specify null string

Select this check box and from the list displayed select a
string that represents a null value in unload files.

Escape

Select this check box to place an escape character () before
every occurrence of the following characters for CHAR and VARCHAR columns in
the delimited unload files: linefeed (
), carriage return (
), the delimiter
character specified for the unloaded data, the escape character (), a quote
character (” or ‘).

Overwrite s3 object if exist

Select this check box to overwrite the existing Amazon S3
object files.

Parallel

Select this check box to write data in parallel to multiple
unload files on Amazon S3 according to the number of slices in the Redshift
cluster.

tStatCatcher Statistics

Select this check box to gather the Job processing metadata at
the Job level as well as at each component level.

Global Variables

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

This component covers all possible SQL queries for the Amazon
Redshift database.

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.