tMarkLogicInput properties - 6.3

Talend Open Studio for Big Data Components Reference Guide

EnrichVersion
6.3
EnrichProdName
Talend Open Studio for Big Data
task
Data Governance
Data Quality and Preparation
Design and Development
EnrichPlatform
Talend Studio

Component family

Big Data/MarkLogic

Basic settings

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.

Since version 5.6, both the Built-In mode and the Repository mode are available in any of the Talend solutions.

 

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.

Note

When a Job contains the parent Job and the child Job, if you need to share an existing connection between the two levels, for example, to share the connection created by the parent Job with the child Job, you have to:

  1. In the parent level, register the database connection to be shared in the Basic settings view of the connection component which creates that very database connection.

  2. In the child level, use a dedicated connection component to read that registered database connection.

For an example about how to share a database connection across Job levels, see Talend Studio User Guide.

 

Host

Enter the IP address or hostname of the MarkLogic server.

 

Port

Enter the listening port number of the MarkLogic server.

 

Database

Enter the name of the MarkLogic database you want to use.

 

Username and Password

Enter the user authentication data to access the MarkLogic database.

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.

 

Authentication

Select an authentication type from the list, either DIGEST or BASIC. For more information about the types of authentication, see http://docs.marklogic.com/guide/security/authentication#id_56266.

 

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. The schema is either Built-In or stored remotely in the Repository.

Since version 5.6, both the Built-In mode and the Repository mode are available in any of the Talend solutions.

The schema of this component is read-only. You can click the [...] button next to Edit schema to view the predefined schema that contains the following two columns:

  • docId: the URI of the document.

  • docContent: the content of the document.

 

Query Criteria

Specify the string query based on which the search is performed. For more information about the string query, see https://docs.marklogic.com/guide/search-dev/string-query.

Advanced settings

Maximal Retrieve Number

Enter the maximum number of documents to be retrieved.

 

Use Query Option

Select this check box to customize the query with a query option. The query option will be stored on the REST server and can then be referenced by name by other queries. For more information about the query options, see http://docs.marklogic.com/guide/java/query-options#id_20346.

Query Literal Type: select a type of presentation from which the query option is created, either XML or JSON.

Query Option Name: specify the name of the query option.

Query Option Literals: implement the query option from a raw XML or JSON representation according to the selected representation type.

 

tStatCatcher Statistics

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

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 Scenario 3: Reading data from MySQL databases through context-based dynamic connections and Scenario: 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.

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 usually used as a start component and it needs an output flow.

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.