tNeo4jInput Standard properties - 6.5

Neo4j

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 > Neo4j components
Data Quality and Preparation > Third-party systems > Database components > Neo4j components
Design and Development > Third-party systems > Database components > Neo4j components
EnrichPlatform
Talend Studio

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

The Standard tNeo4jInput 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

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.

DB version

Select the Neo4j version you are using.

When you are using Neo4j version 3.2.X, this component works in the remote mode only. Therefore, if you want to reuse a connection to Neo4j V3.2.X from tNeo4jConnection, ensure that you have selected the Remote server check box and properly configured the connection.

Do not use a 2.X.X version and a 3.X.X version in the same Job. Otherwise, class conflict issues occur.

Neo4j version 2.X.X is compatible only with Java 7 or higher but it offers support of advanced features such as node labels.

This list is not shown if the Use an existing connection check box is selected.

Upon selecting a database version, you will be prompted to install the corresponding database driver JAR files if not yet installed. For details about how to install external modules, see Installing external modules.

Shutdown after job

Select this check box to shutdown the Neo4j database connection when no more operations on Neo4j are going to be performed after the current component.

Alternatively, you can use tNeo4jClose to shutdown the database.

This avoids errors such as "Id file not properly shutdown" at next execution of Jobs involving Neo4j.

This check box is available only if the Use an existing connection check box is not selected.

Remote server

Select this check box if you use a Neo4j remote server, and specify the root URL in the Server URL field.

  • Set username: this check box is available when you have selected the Use a remote server check box and the Neo4j version you are using is earlier than 2.2. If the remote Neo4j server you want to connect to does not require user credentials, leave it clear.

  • Username and Password: enter the authentication information to connect to the remote Neo4j server to be used. Since Neo4j 2.2, user credentials are always required.

This check box appears only if you do not select the Use an existing connection check box and you are not using Neo4j V3.2.X. With V3.2.X, this component supports the remote mode only.

Database path

If you use Neo4j in embedded mode, specify the path of data file.

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

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.

Query

Enter your Cypher query in double quotes, with return parameters matching the mapping table.

Mapping

Complete this table to specify the column or columns to be extracted and the corresponding column family or families. The Column fields of this table are automatically filled once you have defined the schema; fill the Return parameter fields with return parameters to map the node properties in the Cypher query with the schema columns.

Be sure to enclose your return parameters in double quotes.

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.

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 always needs an output link.
Limitation n/a