Document toolboxDocument toolbox

Neo4j Sink

Description

This unit is a Sink unit type.

A unit that stores events into a Neo4j database.

All events enter through the in port. Then, the unit executes the query specified in its properties. Successful results are sent to the Neo4j database using the connection details configured for the unit. 

If an error occurs, an event is enriched with standard error fields and sent to the error output port.

Configuration

After dragging this unit into the Flow canvas, double-click it to access its configuration options. The following table describes the configuration options of this unit:

TabFieldDescription
GeneralNameEnter a name for the unit. It must start with a letter, and cannot contain spaces. Only letters, numbers, and underscores are allowed.
QueryExpression, written in Cypher, that will determine the behavior of the unit.
ParametersParameters

A list of field names to be used as parameters in the query.

ConnectionNeo4j urlThe URL (bolt://ip:port) of the host running the Neo4j database.
UsernameThe client name to access Neo4j.
PasswordThe password requested to access Neo4j.

Input ports

PortDescription
inAll events enter through this port.

Output ports

PortDescription
errorOutputs all events that produced some error during processing. These events have two additional fields, error, and exception, that describe the error.