Neo4j Graph Output
Description
The Graph Output transform lets you map input fields automatically to a graph model.
The algorithm used to update your graph takes null values for fields mapped to primary properties of nodes into account. These will not merge on these nodes, nor will it create or update relationships to these nodes.
Limitations
- Updates across unknown nodes
()--()
are not supported
Modeling tips
Try a modeler like Cypher Workbench or Arrows and import the result into a Graph Model.
Keep your models as simple as possible.
Make sure that every defined node has a primary key field
Limit yourself to one primary key field per node
Execution tips
- Make sure that every node primary key has an index. Use the provided button in the graph model editor to generate the Neo4j Index and Constraint actions which will handle this for you.
Notable options
Option | Description |
Transform name | the name for this transform in the pipeline |
Neo4j connection | the Neo4j connection to write the graph to |
Graph model | the Neo4j graph model to use |
Batch size (rows) | batch size to use for writing data to Neo4j |
Create indexes? | create Neo4j indexes before running this transform |
Return graph data? | return graph data returned by Neo4j |
Graph output field name | the name of the field to write the graph data to (if |
Validate against model? | validate the data against the model. This will check if indexes are created for a field that is flagged as primary/indexed, see if a property flagged as mandatory is available when a node is updated and so on. Uniqueness is best validated by a constraint on the property. Use the provided button to generate the “Neo4j Constraint” action. |
Allow out of order updates? | If out of order updates are allowed, this transform generates unwind statements. Otherwise, standard batch updates are used. The updates are grouped per distinct generated cypher statement. |
Field to property mappings tab | On this tab you can specify where you want the input fields to end up in the graph. Based on your selections for this mapping the appropriate Cypher Merge statements will be executed. You can map fields to node and relationship properties. For the very specific cases when you want to create relationships between 2 nodes with the same label (self relationships) you can specify to which node your mapping goes: the source or target node. |
Field to relationship mappings tab | Sometimes you want to select a relationship in your graph model based on input data. Here are the 4 different types of relationship mappings you can apply to steer this behavior: |
Node label mappings tab | In case you want to select specific labels from the ones specified in the graph model you can create mapping entries in this tab. Here are the node mapping types: |