tRedshiftOutputBulk Standard properties - 7.1

Amazon Redshift

author
Talend Documentation Team
EnrichVersion
Cloud
7.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 ESB
Talend Open Studio for MDM
Talend Real-Time Big Data Platform
task
Data Governance > Third-party systems > Amazon services (Integration) > Amazon Redshift components
Data Quality and Preparation > Third-party systems > Amazon services (Integration) > Amazon Redshift components
Design and Development > Third-party systems > Amazon services (Integration) > Amazon Redshift components
EnrichPlatform
Talend Studio

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

The Standard tRedshiftOutputBulk 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 Dynamic database components.

Basic settings

Database

Select a type of database from the list and click Apply.

Data file path at local

Specify the local path to the file to be generated.

Note that the file is generated on the same machine where the Studio is installed or where the Job using this component is deployed.

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

 

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.

Compress the data file

Select this check box and select a compression type from the list displayed to compress the data file.

This check box disappears when the Append the local file check box is selected.

Encrypt

Select this check box to generate and upload the data file to Amazon S3 using client-side encryption. In the Encryption key field displayed, enter the encryption key used to encrypt the file.

By default, this check box is cleared and the data file will be uploaded to Amazon S3 using server-side encryption.

For more information about the client-side and server-side encryption, see Protecting Data Using Encryption.

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.

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.

Inherit credentials from AWS role

Select this check box to obtain AWS security credentials from Amazon EC2 instance metadata. To use this option, the Amazon EC2 instance must be started and your Job must be running on Amazon EC2. For more information, see Using an IAM Role to Grant Permissions to Applications Running on Amazon EC2 Instances.

Assume role

Select this check box and specify the values for the following parameters used to create a new assumed role session.
  • Role ARN: the Amazon Resource Name (ARN) of the role to assume.

  • Role session name: an identifier for the assumed role session.

  • Session duration (minutes): the duration (in minutes) for which we want to have the assumed role session to be active.

For more information on assuming roles, see AssumeRole.

Region

Specify the AWS region by selecting a region name from the list or entering a region between double quotation marks (e.g. "us-east-1") in the list. For more information about the AWS Region, see Regions and Endpoints.

STS Endpoint

Select this check box and in the field displayed, specify the AWS Security Token Service endpoint, for example, sts.amazonaws.com, where session credentials are retrieved from.

This check box is available only when the Assume role check box is selected.

Bucket

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

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.

Key

Type in an object key to assign to the file uploaded to Amazon S3.

Advanced settings

Field Separator

Enter the character used to separate fields.

Text enclosure

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

Delete local file after putting it to s3

Select this check box to delete the local file after being uploaded to Amazon S3. By default, this check box is selected.

Create directory if not exists

Select this check box to create the directory specified in the Data file path at local field if it does not exist. By default, this check box is selected.

Encoding

Select an encoding type for the data in the file to be generated.

Config client

Select this check box to configure client parameters for Amazon S3. Click the [+] button below the table displayed to add as many rows as needed, each row for a client parameter, and set the following attributes for each parameter:

  • Client Parameter: Click the cell and select a parameter from the drop-down list.

  • Value: Enter the value for the corresponding client parameter.

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

Global Variables

NB_LINE: the number of rows processed. 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

Usage rule

This component is more commonly used with the tRedshiftBulkExec component to feed Amazon Redshift with a delimited/CSV file. Used together they offer gains in performance while feeding Amazon Redshift.