tMarkLogicInput Standard properties

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.

Use an existing connection

Select this check box and in the Component List drop-down list, select the desired connection component to reuse the connection details you already defined.

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. When you create a Spark Job, avoid the reserved word line when naming the fields.

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.

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.

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 rule

This component is usually used as a start component and it needs an output flow.

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