tCouchDBConnection - 6.3

Talend Components Reference Guide

EnrichVersion
6.3
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 Data Quality
Talend Open Studio for ESB
Talend Open Studio for MDM
Talend Real-Time Big Data Platform
task
Data Governance
Data Quality and Preparation
Design and Development
EnrichPlatform
Talend Studio

Warning

This component is available in the Palette of the studio only if you have subscribed to one of the Talend solutions with Big Data.

Function

tCouchDBConnection opens a connection to a CouchDB server.

Purpose

tCouchDBConnection enables the reuse of the connection it creates to a CouchDB server, and allows you to configure replication parameters if a replication is triggered between the source database and the target database.

tCouchDBConnection properties

Component Family

Big Data / CouchDB

 

Basic settings

DB Version

Select the CouchDB version that you are using.

 

Server

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

 

Port

Type in the listening port number of the CouchDB server.

 

Database

Type in the database that you want to use.

Authentication

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

Replicate target database

Select the check box to set the replication in the table that appears.

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.

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

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

This component is generally used with other CouchDB components, particularly tCouchDBClose.

Log4j

If you are using a subscription-based version of the Studio, the activity of this component can be logged using the log4j feature. For more information on this feature, see Talend Studio User Guide.

For more information on the log4j logging levels, see the Apache documentation at http://logging.apache.org/log4j/1.2/apidocs/org/apache/log4j/Level.html.

Limitation

n/a

Related scenario

For a scenario in which tCouchDBConnection is used, see Scenario: Replicating data from the source database to the target database.