tNeo4jOutput Standard properties - 7.0

Neo4j

author
Talend Documentation Team
EnrichVersion
7.0
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 tNeo4jOutput running in the Standard Job framework.

The Standard tNeo4jOutput component belongs to the Big Data and the Databases families.

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

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.

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.

Remote server

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

Database path

If you use Neo4j in embedded mode, specify the directory to hold your data files. If the specified directory does not exist, it will be created.

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

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.

Mapping

Click the [...] button or double-click the component on the design workspace to open the indexes and relationships mapping editor. Use it to index node or create relationships during the node insertion.

  • Select the Auto indexed check box for a column to automatically index nodes with this property.
  • Index creation: With a column selected, click the [+] button to create as many indexes as you want on nodes with the property corresponding to the selected column.
    • Name: Specify an index name in double quotes.
    • Key: Specify an index key in double quotes.
    • Value (empty for current row): Specify an index value in double quotes. If you leave this field empty, the default value of the index added on each node will be the value of this property of the current node.
    • Unique: Select this check box if you want the defined index to be created only once within the graph, rather than on each node.
  • Relationship creation: With a column selected, click the [+] button to create as many relationships as you want for nodes with the property corresponding to the selected column.
    • Type: Specify a relationship type in double quotes.
    • Direction: Select a relationship direction, between Outgoing and Incoming.
    • Index name: Specify an index name for the relationship, in double quotes.
    • Index key: Specify an index key for the relationship, in double quotes.
    • Value (empty for current row): Specify an index value for the relationship, in double quotes. If you leave this field empty, the default value of the index added on the relationship will be the value of this property of the current node.

Use label (Neo4j > 2.0)

Select this check box to create nodes with a label. Enter your label name in the Label name field.

This check box is not shown if Neo4J 1.X.X is selected from the DB Version list or Delete is selected from the Data action list.

Note that this option works only with Neo4j 2.0 onwards and Java 7.

Data action

On the data of the node, you can perform:

  • Insert: Add new node to the database.
  • Update: Make changes to existing entries.
  • Update or insert: Search the node with an index to update and make changes. If the node doesn't exist, a new node will be inserted.
  • Delete: Remove nodes fetched by the index according to the input flow.

Index name

Specify the index name to query.

This field is available only if the action selected in Data action is other than Insert.

Index key

Specify the index key to query.

This field is available only if the action selected in Data action is other than Insert.

Index value

Select the index value to query.

This field is available only if the action selected in Data action is other than Insert.

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.

 

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.

Advanced settings

Commit every

Enter the number of rows to be completed before committing batches of nodes to the DB. This option ensures transaction quality (but not rollback) and, above all, better performance at execution.

Warning: This option is only supported by the embedded mode of the database. You can't make transactions in REST mode.

Batch import

Select this check box to activate the batch mode.

Warning:
  • This option is only supported by the embedded mode of the database.
  • It is recommended that you perform a backup operation before executing the Job to prevent data corruption.
Note: If you have configured index creation on multiple columns in the Mapping table, it is recommended that you select the Unique check box in the index setting for the last column to avoid creating unwanted redundant indexes that may cause batch load issues.

If you want more explanations about memory mapping configuration of batch import, please refer to Neo4j documentation at: http://neo4j.com/docs/stable/batchinsert-examples.html.

Node store mapped memory

Type in the memory size in MB allocated to nodes.

Relationship store mapped memory

Type in the memory size in MB allocated to relationships.

Property store mapped memory

Type in the memory size in MB allocated to property.

String store mapped memory

Type in the memory size in MB allocated to strings.

Array store mapped memory

Type in the memory size in MB allocated to arrays.

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 is used as an output component and it always needs an incoming link.
Limitation n/a