Camel Neo4j component

Available as of Camel 2.11

The neo4j: component allows you to treat Neo4j as a camel producer endpoint. This means you can use this component in to() calls but not from() calls. This component is backed by the Spring Data Neo4j Library.

  • As a producer, can create or remove nodes, and create or remove relationships.
  • Can support as many endpoints as required, eg for multiple databases across multiple instances.
  • Headers set for node id (for created nodes), relationship id (for created relationships)

Maven users will need to add the following dependency to their pom.xml for this component:

    <!-- use the same version as your Camel core version -->

URI format


Where the URL is the location of the of running neo4j rest server.


The following headers are set on exchanges during message transport.

Property Value
Neo4jOperation One of the Neo4jOperation enum values `CREATE_NODE, REMOVE_NODE, CREATE_RELATIONSHIP, REMOVE_RELATIONSHIP` which determines which action to perform
Neo4jNodeId the id of the created node
Neo4jRelationshipId the id of the created relationship

The producer will set the headers for downstream processors once the operation has taken place. Any ID headers set prior to the producer are ignored.


The neo4j component looks for the Neo4jOperation header to determine what kind of entity to create, which is one of the following enum types


The body of the message is used to determine the node or relationship to manipulate. The following body types are supported:


  • null body - create default node
  • Map body - create node with the properties set from the map


  • Long or Integer - remove node using the body as the id
  • neo4j Node instance - remove the node specified by that instance


  • SpringDataRelationship - create relationship specified by any @NodeEntity annoted Spring entities.
  • org.apache.camel.component.neo4j.BasicRelationship - create relationship specified by the neo4j node types


  • Long or Integer - remove relationship using the body as the id
  • SpringDataRelationship - remove relationship specified by the @NodeEntity annoted Spring entities.
  • org.apache.camel.component.neo4j.BasicRelationship - remove relationship specified by the neo4j node types


If you wanted to insert a new empty node every 1 seconds


If you wanted to delete a specific node specified by a filename, eg a file of 100 would delete node 100.

from("file:/var/data").process(new Processor() {
	public void process(Exchange exchange) throws Exception {
© 2004-2011 The Apache Software Foundation.
Apache Camel, Camel, Apache, the Apache feather logo, and the Apache Camel project logo are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.
Graphic Design By Hiram