tNeo4jInput – Docs for ESB 5.x

Component family

Big Data / Neo4j

Function

tNeo4jInput allows you to read data
from Neo4j and send data in the output Talend flow.

Purpose

tNeo4jInput reads data from Neo4j
based on Cypher query allowing any further transformation or
processing of the data in the rest of the Job.

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, between Neo4J 1.X.X and Neo4J 2.X.X.

Note that Neo4j version 2.X.X is compatible only with Java 7 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 DB version, you will be prompted to install the corresponding database
driver JAR files if not yet installed. For more information on installing third-party
modules, see the Talend Installation and Upgrade Guide.

Shutdown after Job (Only embedded
database)

Select this check box if you want to shutdown the Neo4j database
at the end of your Job. Only available in embedded mode.

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

Remote server

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

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

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 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.

Click Edit schema to make changes to the schema. If the
current schema is of the Repository type, three options are
available:

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

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.