tCouchDBOutput Standard properties - 6.5

CouchDB

author
Talend Documentation Team
EnrichVersion
6.5
EnrichProdName
Talend Big Data
Talend Big Data Platform
Talend Data Fabric
Talend Open Studio for Big Data
Talend Real-Time Big Data Platform
task
Data Governance > Third-party systems > Database components > CouchDB components
Data Quality and Preparation > Third-party systems > Database components > CouchDB components
Design and Development > Third-party systems > Database components > CouchDB components
EnrichPlatform
Talend Studio

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

The Standard tCouchDBOutput component belongs to the Big Data and the Databases families.

The component in this framework is available in all Talend products with Big Data.

Basic settings

Schema and Edit schema

A schema is a row description. It defines the number of fields (columns) to Repository. When you create a Spark Job, avoid the reserved word line when naming the fields.

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.

 

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 details, see Verifying default values in a retrieved schema.

Sync columns

Click this button to retrieve schema from the previous component connected in the Job.

Use existing connection

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

DB Version

Select the CouchDB version that you are using.

Server

Hostname or IP address of the CouchDB server.

Port

Listening port number of the CouchDB server.

Database

Name of the database that you want to use.

Required authentication

Select this check box to provide credentials for the CouchDB authentication.

  • Username: Type in the user name for the CouchDB authentication.

  • Password: Type in the password for the CouchDB authentication.

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.

Use trigger replication

Select this check box to trigger replication between databases.

Warning:

This check box appears only if you do not select the Use an existing connection check box.

Target DB name

Specify the target database to which the documents will be copied. It can be a local database name or a remote database URL.

Continuous

Select this check box to continue a replication upon the server restart.

Create target DB

Select this check box to create the target database if it does not exist.

IS Canceled

Select this check box to cancel the existing replication between the specified source database and target database at the end of the Job.

Action on data

On the data of interest, you can perform:

  • Insert: Insert data into the database.

  • Update: Update data in the database.

  • Upsert: Insert the data if they do not exist or update the existing data.

  • Delete: Remove the data from the database.

Generate JSON Document

Select this check box to generate a JSON document and configure the desired data structure for it.

Key

Select the key that you want to use from the list.

Configure JSON Tree

Click the [...] button to open the window for JSON tree configuration. For more information, see Configuring a JSON Tree.

Group by

Customize the input columns based on which you want to group the data.

Remove root node

Select this check box to remove the root node.

Die on error

This check box is cleared by default, meaning to skip the row on error and to complete the process for error-free rows.

Advanced settings

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 read by an input component or transferred to an output component. 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.

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 used as an output component and it always needs an incoming link.