tCouchbaseOutput Standard properties - 7.1

Couchbase

author
Talend Documentation Team
EnrichVersion
7.1
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 > NoSQL components > Couchbase components
Data Quality and Preparation > Third-party systems > NoSQL components > Couchbase components
Design and Development > Third-party systems > NoSQL components > Couchbase components
EnrichPlatform
Talend Studio

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

The Standard tCouchbaseOutput component belongs to the Databases NoSQL family.

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

Basic settings

Bucket

Enter, within double quotation marks, the name of the data bucket in the Couchbase database.

If you are using Couchbase V5.0, this bucket name is the user name you have created in the Security tab of your Couchbase UI.

Since version 7.1, Couchbase V5.5 and V6.0 are supported.

Password

Provide the authentication credentials to a bucket.

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.

If you are using Couchbase V5.0, enter the same value you put in the Bucket field as password, because in Couchbase V5.0, no password is associated with a bucket. However, on Couchbase, you need to create a user with appropriate role to access the buckets.

For further information about the access control and other important requirements on the Couchbase V5.0 side, see Couchbase V5.0 release note: Major Behavior Changes.

Bootstrap nodes

Enter the name or IP of the node to be bootstrapped by Couchbase SDK. As Couchbase recommends to specify multiple nodes to bootstrap, enter the names or IPs of these nodes in this field, separating them using commas (,).

For further information about Couchbase bootstrapping, see How Couchbase SDKs connect to the cluster.

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.

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.

Click Sync columns to retrieve the schema from the previous component connected in the Job.

 

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.

Field to use as ID

Enter, within double quotation marks, the name of the column from the schema of tCouchbaseOutput to provide IDs for the documents to be written to Couchbase.

Die on error

Select the check box to stop the execution of the Job when an error occurs.

Clear the check box to skip any rows on error and 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_SUCCESS: the number of rows successfully processed. This is an After variable and it returns an integer.

NB_REJECT: 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

Usage rule

Preceded by an input component, tCouchbaseOutput wraps flat data into documents for storage in the Couchbase database.