org.mule.modules

mule-module-neo4j

config

Namespace	http://www.mulesoft.org/schema/mule/neo4j
Schema Location	http://www.mulesoft.org/schema/mule/neo4j/current/mule-neo4j.xsd (View Schema)
Schema Version	3.4
Minimum Mule Version	3.4.0

Module Overview

Neo4j Connector, for versions 1.9 or above.

Summary

Configuration
<neo4j:config> Configure an instance of this module

Message Processors
<neo4j:add-autoindexing-property> This method is deprecated. since Neo4j 2.0.0
<neo4j:add-node-label> Add a label to a `Node`.
<neo4j:add-node-labels> Add labels to a `Node`.
<neo4j:add-node-to-index> This method is deprecated. since Neo4j 2.0.0
<neo4j:create-node> Create a `Node`.
<neo4j:create-node-index> This method is deprecated. since Neo4j 2.0.0
<neo4j:create-relationship> Create a `Relationship`.
<neo4j:create-relationship-index> This method is deprecated. since Neo4j 2.0.0
<neo4j:create-schema-index> Create a `SchemaIndex`.
<neo4j:create-unique-node-or-fail> Create a unique `Node` or fail.
<neo4j:create-unique-relationship-or-fail> Create a unique `Relationship` or fail.
<neo4j:delete-autoindexing-property> This method is deprecated. since Neo4j 2.0.0
<neo4j:delete-node> Delete a `Node`.
<neo4j:delete-node-by-id> Delete a `Node`.
<neo4j:delete-node-index> This method is deprecated. since Neo4j 2.0.0
<neo4j:delete-node-label> Delete a label from a node, never failing even if the label doesn't exist.
<neo4j:delete-node-properties> Delete all properties from a `Node`.
<neo4j:delete-node-property> Delete a property from a `Node`.
<neo4j:delete-relationship> Delete a `Relationship`.
<neo4j:delete-relationship-by-id> Delete a `Relationship`.
<neo4j:delete-relationship-index> This method is deprecated. since Neo4j 2.0.0
<neo4j:delete-relationship-properties> Delete all properties of a `Relationship`.
<neo4j:delete-relationship-property> Delete one property of a `Relationship`.
<neo4j:delete-schema-index> Delete a schema index.
<neo4j:execute-batch> Execute a batch of jobs.
<neo4j:find-nodes-by-auto-index> This method is deprecated. since Neo4j 2.0.0
<neo4j:find-nodes-by-auto-index-query> This method is deprecated. since Neo4j 2.0.0
<neo4j:find-nodes-by-index> This method is deprecated. since Neo4j 2.0.0
<neo4j:find-nodes-by-query> This method is deprecated. since Neo4j 2.0.0
<neo4j:get-autoindexing-properties> This method is deprecated. since Neo4j 2.0.0
<neo4j:get-autoindexing-status> This method is deprecated. since Neo4j 2.0.0
<neo4j:get-labels> Get all the labels.
<neo4j:get-node-by-id> Get a `Node`.
<neo4j:get-node-indexes> This method is deprecated. since Neo4j 2.0.0
<neo4j:get-node-labels> Get all the labels of a `Node`.
<neo4j:get-node-relationships> Get the relationships for a particular `Node`.
<neo4j:get-nodes-by-label> Get all the `Node`s that have a particular label and, optional, a particular property.
<neo4j:get-or-create-unique-node> Get or create a unique `Node`.
<neo4j:get-or-create-unique-relationship> Get or create a unique `Relationship`.
<neo4j:get-relationship-by-id> Get a `Relationship`.
<neo4j:get-relationship-indexes> This method is deprecated. since Neo4j 2.0.0
<neo4j:get-relationship-types> Get all the relationship types.
<neo4j:get-schema-indexes> Get the `SchemaIndex`es for a particular label.
<neo4j:get-service-root> Get service root.
<neo4j:remove-node-index-entries> This method is deprecated. since Neo4j 2.0.0
<neo4j:run-cypher-query> Run a cypher query.
<neo4j:set-autoindexing-status> This method is deprecated. since Neo4j 2.0.0
<neo4j:set-node-labels> Set labels of a `Node`.
<neo4j:set-node-properties> Set the properties of a `Node`.
<neo4j:set-node-property> Set a property of a `Node`.
<neo4j:set-relationship-properties> Set the properties of a `Relationship`.
<neo4j:set-relationship-property> Set one property of a `Relationship`.
<neo4j:traverse-for-fullpaths> Perform a node traversal, returning `Fullpath` instances.
<neo4j:traverse-for-fullpaths-with-paging> Perform a paged node traversal, dispatching `Fullpath` instances to the rest of the flow.
<neo4j:traverse-for-nodes> Perform a node traversal, returning `Node` instances.
<neo4j:traverse-for-nodes-with-paging> Perform a paged node traversal, dispatching `Node` instances to the rest of the flow.
<neo4j:traverse-for-path-with-algorithm> Traverse nodes with a particular algorithm, returning the first successful path found.
<neo4j:traverse-for-paths> Perform a node traversal, returning `Path` instances.
<neo4j:traverse-for-paths-with-algorithm> Traverse nodes with a particular algorithm, returning all the successful paths found.
<neo4j:traverse-for-paths-with-paging> Perform a paged node traversal, dispatching `Path` instances to the rest of the flow.
<neo4j:traverse-for-relationships> Perform a node traversal, returning `Relationship` instances.
<neo4j:traverse-for-relationships-with-paging> Perform a paged node traversal, dispatching `Relationship` instances to the rest of the flow.

Configuration

To use the this module within a flow the namespace to the module must be included. The resulting flow will look similar to the following:

<mule xmlns="http://www.mulesoft.org/schema/mule/core"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xmlns:neo4j="http://www.mulesoft.org/schema/mule/neo4j"
      xsi:schemaLocation="
               http://www.mulesoft.org/schema/mule/core
               http://www.mulesoft.org/schema/mule/core/current/mule.xsd
               http://www.mulesoft.org/schema/mule/neo4j
               http://www.mulesoft.org/schema/mule/neo4j/current/mule-neo4j.xsd">

      <!-- here goes your flows and configuration elements -->

</mule>

This module is configured using the config element. This element must be placed outside of your flows and at the root of your Mule application. You can create as many configurations as you deem necessary as long as each carries its own name.

Each message processor, message source or transformer carries a config-ref attribute that allows the invoker to specify which configuration to use.

Attributes
Type	Name	Default Value	Description	Java Type	MIME Type	Encoding
xs:string	name		Optional. Give a name to this configuration so it can be later referenced.
	connector		Optional. The connector to use to reach Neo4j: configure only if there is more than one HTTP/HTTPS connector active in your Mule application.
xs:string	password		Optional. The password used to authenticate to Neo4j.
xs:boolean	streaming	true	Optional. Should streaming be used when communicating with the Neo4j server.
xs:string	user		Optional. The user used to authenticate to Neo4j.

Example

INCLUDE_ERROR

Example

INCLUDE_ERROR

Connection Pool

This connector offers automatic connection management via the use of a connection pool. The pool will act a storage mechanism for all the connections that are in-use by the user of this connector.

Prior to execution of a processor, the connector will attempt to lookup an already established connection and if one doesn't exists it will create one. That lookup mechanism is done in the connection pool via the use of connection variables declared as keys.

The user of the connector can configure the pool by adding a connection-pooling-profile to the connector configuration like this:

    <neo4j:connection-pooling-profile maxActive="10" maxIdle="10"
                             exhaustedAction="WHEN_EXHAUSTED_GROW" maxWait="120" minEvictionMillis="60000" evictionCheckIntervalMillis="30000"/>

The following is a list of connection attributes, each connection attribute can be configured at the config element level or they can also be added to each processor. If they are used at the processor level they get the benefit of full expression resolution.

Connection Attributes
Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
baseUri	http://localhost:7474/db/data	The base URI of the Neo4j server API.	String	/	UTF-8

Reconnection Strategies

Reconnection Strategies specify how a connector behaves when its connection fails. You can control how Mule attempts to reconnect by specifying a number of criteria:

The type of exception
Number and frequency of reconnection attempts
The notifications generated, and more

With a reconnection strategy, you can better control the behavior of a failed connection, by configuring it, for example, to re-attempt the connection only once every 15 minutes, and to give up after 30 attempts. You can also send an automatic notification to your IT administrator whenever this reconnection strategy goes into effect. You can even define a strategy that attempts to reconnect only during business hours. Such a setting can prove useful if your server is frequently shut down for nightly maintenance.

Configuration

A reconnection strategy that allows the user to configure how many times a reconnection should be attempted and how long to wait between attempts.

    <neo4j:config>
         <reconnect count="5" frequency="1000"/>
    </neo4j:config>

Reconnect Attributes
Name	Default Value	Description
frequency	2000	Optional. How often (in ms) to reconnect
count	2	Optional. How many reconnection attempts to make

For more information about reconnection strategies in Mule, or even how to write your own custom reconnection strategy please check this section.

Message Processors

<neo4j:add-autoindexing-property>

This method is deprecated.
since Neo4j 2.0.0

Add a property for autoindexing on nodes.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
propertyName		The property to add.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
baseUri	http://localhost:7474/db/data	Optional. The base URI of the Neo4j server API.	String	/	UTF-8

Exception Payloads

Payload Class	Description
MuleException	if anything goes wrong with the operation.

<neo4j:add-node-label>

Add a label to a Node.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
node		The `Node` to add a label to.	Node	/
label		The label to add.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
baseUri	http://localhost:7474/db/data	Optional. The base URI of the Neo4j server API.	String	/	UTF-8

Exception Payloads

Payload Class	Description
MuleException	if anything goes wrong with the operation.

<neo4j:add-node-labels>

Add labels to a Node.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
node		The `Node` to add labels to.	Node	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
baseUri	http://localhost:7474/db/data	Optional. The base URI of the Neo4j server API.	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<neo4j:labels>		A List of labels to add.	List<String>

Exception Payloads

Payload Class	Description
MuleException	if anything goes wrong with the operation.

<neo4j:add-node-to-index>

This method is deprecated.
since Neo4j 2.0.0

Add a Node to an index.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
indexName		The name of the index to add the node to.	String	/	UTF-8
node		The node to add.	Node	/
key		The key to use with the index entry.	String	/	UTF-8
value		The value to use with the index entry.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
baseUri	http://localhost:7474/db/data	Optional. The base URI of the Neo4j server API.	String	/	UTF-8

Returns

Return Type	Description
IndexedNode	an `IndexedNode` instance.

Exception Payloads

Payload Class	Description
MuleException	if anything goes wrong with the operation.

<neo4j:create-node>

Create a Node.

XML Sample

INCLUDE_ERROR

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
baseUri	http://localhost:7474/db/data	Optional. The base URI of the Neo4j server API.	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<neo4j:properties>		Optional. The properties of the node.	Map<String, Object>

Returns

Return Type	Description
Node	the created `Node` instance.

Exception Payloads

Payload Class	Description
MuleException	if anything goes wrong with the operation.

<neo4j:create-node-index>

This method is deprecated.
since Neo4j 2.0.0

Create a node index.

XML Sample

INCLUDE_ERROR

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
indexName		The name of the new node index to create.	String	/	UTF-8
type		Optional. The type of the new node index.	String	/	UTF-8
provider		Optional. The provider for the new node index.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
baseUri	http://localhost:7474/db/data	Optional. The base URI of the Neo4j server API.	String	/	UTF-8

Returns

Return Type	Description
Index	the created NodeIndex.

Exception Payloads

Payload Class	Description
MuleException	if anything goes wrong with the operation.

<neo4j:create-relationship>

Create a Relationship.

XML Sample

INCLUDE_ERROR

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
fromNode		The node where the relationship starts.	Node	/
toNode		The node where the relationship ends.	Node	/
type		The type of relationship.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
baseUri	http://localhost:7474/db/data	Optional. The base URI of the Neo4j server API.	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<neo4j:properties>		Optional. The properties of the relationship.	Map<String, Object>

Returns

Return Type	Description
Relationship	the created `Relationship` instance.

Exception Payloads

Payload Class	Description
MuleException	if anything goes wrong with the operation.

<neo4j:create-relationship-index>

This method is deprecated.
since Neo4j 2.0.0

Create a relationship index.

XML Sample

INCLUDE_ERROR

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
indexName		The name of the new node index to create.	String	/	UTF-8
type		Optional. The type of the new node index.	String	/	UTF-8
provider		Optional. The provider for the new node index.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
baseUri	http://localhost:7474/db/data	Optional. The base URI of the Neo4j server API.	String	/	UTF-8

Returns

Return Type	Description
Index	the created NodeIndex.

Exception Payloads

Payload Class	Description
MuleException	if anything goes wrong with the operation.

<neo4j:create-schema-index>

Create a SchemaIndex.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
label		The label to create the index for.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
baseUri	http://localhost:7474/db/data	Optional. The base URI of the Neo4j server API.	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<neo4j:property-keys>		The property key or keys to index.	List<String>

Returns

Return Type	Description
SchemaIndex	the created `SchemaIndex`.

Exception Payloads

Payload Class	Description
MuleException	if anything goes wrong with the operation.

<neo4j:create-unique-node-or-fail>

Create a unique Node or fail.

XML Sample

INCLUDE_ERROR

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
indexName		The name of the index.	String	/	UTF-8
key		The key for the index.	String	/	UTF-8
value		The value for the index's key.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
baseUri	http://localhost:7474/db/data	Optional. The base URI of the Neo4j server API.	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<neo4j:properties>		Optional. The properties of the node.	Map<String, Object>

Returns

Return Type	Description
IndexedNode	the created or pre-existing `Node` instance.

Exception Payloads

Payload Class	Description
MuleException	if anything goes wrong with the operation.

<neo4j:create-unique-relationship-or-fail>

Create a unique Relationship or fail.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
relationshipName		The name of the relationship.	String	/	UTF-8
type		The type of the relationship.	String	/	UTF-8
key		The index key.	String	/	UTF-8
value		The index value.	String	/	UTF-8
startNode		The start `Node`.	Node	/
endNode		The end `Node`.	Node	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
baseUri	http://localhost:7474/db/data	Optional. The base URI of the Neo4j server API.	String	/	UTF-8

Returns

Return Type	Description
IndexedRelationship	the created `Relationship` instance.

Exception Payloads

Payload Class	Description
MuleException	if anything goes wrong with the operation.

<neo4j:delete-autoindexing-property>

This method is deprecated.
since Neo4j 2.0.0

Delete a property for autoindexing on nodes.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
propertyName		The property to remove.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
baseUri	http://localhost:7474/db/data	Optional. The base URI of the Neo4j server API.	String	/	UTF-8

Exception Payloads

Payload Class	Description
MuleException	if anything goes wrong with the operation.

<neo4j:delete-node>

Delete a Node.

XML Sample

INCLUDE_ERROR

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
node		The `Node` to delete.	Node	/
failIfNotFound	false	Optional. If true, an exception will be thrown if the node is not found and couldn't be deleted.	boolean	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
baseUri	http://localhost:7474/db/data	Optional. The base URI of the Neo4j server API.	String	/	UTF-8

Exception Payloads

Payload Class	Description
MuleException	if anything goes wrong with the operation.

<neo4j:delete-node-by-id>

Delete a Node.

XML Sample

INCLUDE_ERROR

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
nodeId		Id of the node to delete.	long	/
failIfNotFound	false	Optional. If true, an exception will be thrown if the node is not found and couldn't be deleted.	boolean	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
baseUri	http://localhost:7474/db/data	Optional. The base URI of the Neo4j server API.	String	/	UTF-8

Exception Payloads

Payload Class	Description
MuleException	if anything goes wrong with the operation.

<neo4j:delete-node-index>

This method is deprecated.
since Neo4j 2.0.0

Delete a node index.

XML Sample

INCLUDE_ERROR

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
indexName		The name of the node index to delete.	String	/	UTF-8
failIfNotFound	false	Optional. If true, an exception will be thrown if the node index is not found and couldn't be deleted.	boolean	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
baseUri	http://localhost:7474/db/data	Optional. The base URI of the Neo4j server API.	String	/	UTF-8

Exception Payloads

Payload Class	Description
MuleException	if anything goes wrong with the operation.

<neo4j:delete-node-label>

Delete a label from a node, never failing even if the label doesn't exist.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
node		The `Node` to delete the label from.	Node	/
label		The label to delete.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
baseUri	http://localhost:7474/db/data	Optional. The base URI of the Neo4j server API.	String	/	UTF-8

Exception Payloads

Payload Class	Description
MuleException	if anything goes wrong with the operation.

<neo4j:delete-node-properties>

Delete all properties from a Node.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
node		The `Node` to delete properties from.	Node	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
baseUri	http://localhost:7474/db/data	Optional. The base URI of the Neo4j server API.	String	/	UTF-8

Exception Payloads

Payload Class	Description
MuleException	if anything goes wrong with the operation.

<neo4j:delete-node-property>

Delete a property from a Node.

XML Sample

INCLUDE_ERROR

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
node		The `Node` to delete the property from.	Node	/
key		The key of the property.	String	/	UTF-8
failIfNotFound	false	Optional. If true, an exception will be thrown if the property is not found and couldn't be deleted.	boolean	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
baseUri	http://localhost:7474/db/data	Optional. The base URI of the Neo4j server API.	String	/	UTF-8

Exception Payloads

Payload Class	Description
MuleException	if anything goes wrong with the operation.

<neo4j:delete-relationship>

Delete a Relationship.

XML Sample

INCLUDE_ERROR

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
relationship		The `Relationship` to delete.	Relationship	/
failIfNotFound	false	Optional. If true, an exception will be thrown if the relationship is not found and couldn't be deleted.	boolean	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
baseUri	http://localhost:7474/db/data	Optional. The base URI of the Neo4j server API.	String	/	UTF-8

Exception Payloads

Payload Class	Description
MuleException	if anything goes wrong with the operation.

<neo4j:delete-relationship-by-id>

Delete a Relationship.

XML Sample

INCLUDE_ERROR

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
relationshipId		The ID of the relationship to delete.	long	/
failIfNotFound	false	Optional. If true, an exception will be thrown if the relationship is not found and couldn't be deleted.	boolean	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
baseUri	http://localhost:7474/db/data	Optional. The base URI of the Neo4j server API.	String	/	UTF-8

Exception Payloads

Payload Class	Description
MuleException	if anything goes wrong with the operation.

<neo4j:delete-relationship-index>

This method is deprecated.
since Neo4j 2.0.0

Delete a relationship index.

XML Sample

INCLUDE_ERROR

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
indexName		The name of the node index to delete.	String	/	UTF-8
failIfNotFound	false	Optional. If true, an exception will be thrown if the node index is not found and couldn't be deleted.	boolean	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
baseUri	http://localhost:7474/db/data	Optional. The base URI of the Neo4j server API.	String	/	UTF-8

Exception Payloads

Payload Class	Description
MuleException	if anything goes wrong with the operation.

<neo4j:delete-relationship-properties>

Delete all properties of a Relationship.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
relationship		The `Relationship` to delete from.	Relationship	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
baseUri	http://localhost:7474/db/data	Optional. The base URI of the Neo4j server API.	String	/	UTF-8

Exception Payloads

Payload Class	Description
MuleException	if anything goes wrong with the operation.

<neo4j:delete-relationship-property>

Delete one property of a Relationship.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
relationship		The `Relationship` to delete from.	Relationship	/
key		The key of the property.	String	/	UTF-8
failIfNotFound	false	Optional. If true, an exception will be thrown if the property is not found and couldn't be deleted.	boolean	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
baseUri	http://localhost:7474/db/data	Optional. The base URI of the Neo4j server API.	String	/	UTF-8

Exception Payloads

Payload Class	Description
MuleException	if anything goes wrong with the operation.

<neo4j:delete-schema-index>

Delete a schema index.

XML Sample

INCLUDE_ERROR

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
label		The label to delete the schema index from.	String	/	UTF-8
propertyKey		The property key to delete the schema index for.	String	/	UTF-8
failIfNotFound	false	Optional. If true, an exception will be thrown if the schema index is not found and couldn't be deleted.	boolean	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
baseUri	http://localhost:7474/db/data	Optional. The base URI of the Neo4j server API.	String	/	UTF-8

Exception Payloads

Payload Class	Description
MuleException	if anything goes wrong with the operation.

<neo4j:execute-batch>

Execute a batch of jobs.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
baseUri	http://localhost:7474/db/data	Optional. The base URI of the Neo4j server API.	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<neo4j:jobs>		The batch to execute.	List<ConfigurableBatchJob>

Returns

Return Type	Description
Collection<BatchJobResult>	a Collection of `BatchJobResult`, never null but possibly empty.

Exception Payloads

Payload Class	Description
MuleException	if anything goes wrong with the operation.

<neo4j:find-nodes-by-auto-index>

This method is deprecated.
since Neo4j 2.0.0

Find nodes by exact match on an auto-index.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
key		The key to use.	String	/	UTF-8
value		The value to use.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
baseUri	http://localhost:7474/db/data	Optional. The base URI of the Neo4j server API.	String	/	UTF-8

Returns

Return Type	Description
Collection<IndexedNode>	a Collection of `IndexedNode`s, never null but possibly empty.

Exception Payloads

Payload Class	Description
MuleException	if anything goes wrong with the operation.

<neo4j:find-nodes-by-auto-index-query>

This method is deprecated.
since Neo4j 2.0.0

Find nodes by query on an auto-index.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
query		The query to run.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
baseUri	http://localhost:7474/db/data	Optional. The base URI of the Neo4j server API.	String	/	UTF-8

Returns

Return Type	Description
Collection<IndexedNode>	a Collection of `IndexedNode`s, never null but possibly empty.

Exception Payloads

Payload Class	Description
MuleException	if anything goes wrong with the operation.

<neo4j:find-nodes-by-index>

This method is deprecated.
since Neo4j 2.0.0

Find nodes by exact index match.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
indexName		The name of the index to use for the search.	String	/	UTF-8
key		The key to use.	String	/	UTF-8
value		The value to use.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
baseUri	http://localhost:7474/db/data	Optional. The base URI of the Neo4j server API.	String	/	UTF-8

Returns

Return Type	Description
Collection<IndexedNode>	a Collection of `IndexedNode`s, never null but possibly empty.

Exception Payloads

Payload Class	Description
MuleException	if anything goes wrong with the operation.

<neo4j:find-nodes-by-query>

This method is deprecated.
since Neo4j 2.0.0

Find nodes by index query.

XML Sample

INCLUDE_ERROR

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
indexName		The name of the index to use for the search.	String	/	UTF-8
query		The query to run.	String	/	UTF-8
order		Optional. The desired `Neo4jConnector.QueryResultOrder`.	Neo4jConnector.QueryResultOrder	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
baseUri	http://localhost:7474/db/data	Optional. The base URI of the Neo4j server API.	String	/	UTF-8

Returns

Return Type	Description
Collection<IndexedNode>	a Collection of `IndexedNode`s, never null but possibly empty.

Exception Payloads

Payload Class	Description
MuleException	if anything goes wrong with the operation.

<neo4j:get-autoindexing-properties>

This method is deprecated.
since Neo4j 2.0.0

Get the properties being autoindexed.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
baseUri	http://localhost:7474/db/data	Optional. The base URI of the Neo4j server API.	String	/	UTF-8

Returns

Return Type	Description
Collection<String>	a Collection of String instances, never null but potentially empty.

Exception Payloads

Payload Class	Description
MuleException	if anything goes wrong with the operation.

<neo4j:get-autoindexing-status>

This method is deprecated.
since Neo4j 2.0.0

Get current status for autoindexing on nodes.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
baseUri	http://localhost:7474/db/data	Optional. The base URI of the Neo4j server API.	String	/	UTF-8

Returns

Return Type	Description
Neo4jConnector.AutoIndexingStatus	an Neo4jConnector#AutoIndexingStatus.

Exception Payloads

Payload Class	Description
MuleException	if anything goes wrong with the operation.

<neo4j:get-labels>

Get all the labels.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
baseUri	http://localhost:7474/db/data	Optional. The base URI of the Neo4j server API.	String	/	UTF-8

Returns

Return Type	Description
Collection<String>	a Collection of String labels, never null but potentially empty.

Exception Payloads

Payload Class	Description
MuleException	if anything goes wrong with the operation.

<neo4j:get-node-by-id>

Get a Node.

XML Sample

INCLUDE_ERROR

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
nodeId		Id of the node to get.	long	/
failIfNotFound	false	Optional. If true, an exception will be thrown if the node is not found, otherwise null will be returned.	boolean	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
baseUri	http://localhost:7474/db/data	Optional. The base URI of the Neo4j server API.	String	/	UTF-8

Returns

Return Type	Description
Node	a `Node` instance or null.

Exception Payloads

Payload Class	Description
MuleException	if anything goes wrong with the operation.

<neo4j:get-node-indexes>

This method is deprecated.
since Neo4j 2.0.0

Get all the node indexes.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
baseUri	http://localhost:7474/db/data	Optional. The base URI of the Neo4j server API.	String	/	UTF-8

Returns

Return Type	Description
Collection<Index>	a Collection of NodeIndexes, never null but can be empty.

Exception Payloads

Payload Class	Description
MuleException	if anything goes wrong with the operation.

<neo4j:get-node-labels>

Get all the labels of a Node.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
node		The `Node` from which to get the labels.	Node	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
baseUri	http://localhost:7474/db/data	Optional. The base URI of the Neo4j server API.	String	/	UTF-8

Returns

Return Type	Description
Collection<String>	a Collection of String representing the labels, never null but possible empty.

Exception Payloads

Payload Class	Description
MuleException	if anything goes wrong with the operation.

<neo4j:get-node-relationships>

Get the relationships for a particular Node.

XML Sample

INCLUDE_ERROR

XML Sample

INCLUDE_ERROR

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
node		The `Node` for which relationships are considered.	Node	/
direction		The `Neo4jConnector.RelationshipDirection` to use.	Neo4jConnector.RelationshipDirection	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
baseUri	http://localhost:7474/db/data	Optional. The base URI of the Neo4j server API.	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<neo4j:types>		Optional. The relationship types to look for.	List<String>

Returns

Return Type	Description
Collection<Relationship>	a Collection of `Relationship`, which can be empty but never null.

Exception Payloads

Payload Class	Description
MuleException	if anything goes wrong with the operation.

<neo4j:get-nodes-by-label>

Get all the Nodes that have a particular label and, optional, a particular property.

XML Sample

INCLUDE_ERROR

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
label		The label to use when searching for nodes.	String	/	UTF-8
propertyName		Optional. The property name to use when searching for nodes.	String	/	UTF-8
propertyValue		Optional. The property value to use when searching for nodes.	Object	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
baseUri	http://localhost:7474/db/data	Optional. The base URI of the Neo4j server API.	String	/	UTF-8

Returns

Return Type	Description
Collection<Node>	a Collection of `Node`, never null but possibly empty.

Exception Payloads

Payload Class	Description
MuleException	if anything goes wrong with the operation.

<neo4j:get-or-create-unique-node>

Get or create a unique Node.

XML Sample

INCLUDE_ERROR

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
indexName		The name of the index.	String	/	UTF-8
key		The key for the index.	String	/	UTF-8
value		The value for the index's key.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
baseUri	http://localhost:7474/db/data	Optional. The base URI of the Neo4j server API.	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<neo4j:properties>		Optional. The properties of the node.	Map<String, Object>

Returns

Return Type	Description
IndexedNode	the created or pre-existing `Node` instance.

Exception Payloads

Payload Class	Description
MuleException	if anything goes wrong with the operation.

<neo4j:get-or-create-unique-relationship>

Get or create a unique Relationship.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
relationshipName		The name of the relationship.	String	/	UTF-8
type		The type of the relationship.	String	/	UTF-8
key		The index key.	String	/	UTF-8
value		The index value.	String	/	UTF-8
startNode		The start `Node`.	Node	/
endNode		The end `Node`.	Node	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
baseUri	http://localhost:7474/db/data	Optional. The base URI of the Neo4j server API.	String	/	UTF-8

Returns

Return Type	Description
IndexedRelationship	the pre-existing or created `Relationship` instance.

Exception Payloads

Payload Class	Description
MuleException	if anything goes wrong with the operation.

<neo4j:get-relationship-by-id>

Get a Relationship.

XML Sample

INCLUDE_ERROR

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
relationshipId		The ID of the relationship to retrieve.	long	/
failIfNotFound	false	Optional. If true, an exception will be thrown if the node is not found, otherwise null will be returned.	boolean	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
baseUri	http://localhost:7474/db/data	Optional. The base URI of the Neo4j server API.	String	/	UTF-8

Returns

Return Type	Description
Relationship	a `Relationship` or null.

Exception Payloads

Payload Class	Description
MuleException	if anything goes wrong with the operation.

<neo4j:get-relationship-indexes>

This method is deprecated.
since Neo4j 2.0.0

Get all the relationship indexes.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
baseUri	http://localhost:7474/db/data	Optional. The base URI of the Neo4j server API.	String	/	UTF-8

Returns

Return Type	Description
Collection<Index>	a Collection of NodeIndexes, never null but can be empty.

Exception Payloads

Payload Class	Description
MuleException	if anything goes wrong with the operation.

<neo4j:get-relationship-types>

Get all the relationship types.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
baseUri	http://localhost:7474/db/data	Optional. The base URI of the Neo4j server API.	String	/	UTF-8

Returns

Return Type	Description
Collection<String>	a Collection of String, which can be empty but never null.

Exception Payloads

Payload Class	Description
MuleException	if anything goes wrong with the operation.

<neo4j:get-schema-indexes>

Get the SchemaIndexes for a particular label.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
label		The label to consider.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
baseUri	http://localhost:7474/db/data	Optional. The base URI of the Neo4j server API.	String	/	UTF-8

Returns

Return Type	Description
Collection<SchemaIndex>	a Collection of `SchemaIndex` instances, never null but possibly empty

Exception Payloads

Payload Class	Description
MuleException	if anything goes wrong with the operation.

<neo4j:get-service-root>

Get service root.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
baseUri	http://localhost:7474/db/data	Optional. The base URI of the Neo4j server API.	String	/	UTF-8

Returns

Return Type	Description
ServiceRoot	the service root data.

<neo4j:remove-node-index-entries>

This method is deprecated.
since Neo4j 2.0.0

Remove node index entries.

XML Sample

INCLUDE_ERROR

XML Sample

INCLUDE_ERROR

XML Sample

INCLUDE_ERROR

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
indexName		The name of the index to remove entries from.	String	/	UTF-8
node		The node for which entries will be removed.	Node	/
key		Optional. The key for which entries will be removed.	String	/	UTF-8
value		Optional. The value for which entries will be removed.	String	/	UTF-8
failIfNotFound	false	Optional. If true, an exception will be thrown if no index entry can be deleted.	boolean	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
baseUri	http://localhost:7474/db/data	Optional. The base URI of the Neo4j server API.	String	/	UTF-8

Exception Payloads

Payload Class	Description
MuleException	if anything goes wrong with the operation.

<neo4j:run-cypher-query>

Run a cypher query.

XML Sample

INCLUDE_ERROR

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
query		The query to execute.	String	/	UTF-8
includeStatistics	false	Optional. Defines if meta data about the query must be returned.	boolean	/
profile	false	Optional. Defines if a profile of the executed query must be returned.	boolean	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
baseUri	http://localhost:7474/db/data	Optional. The base URI of the Neo4j server API.	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<neo4j:params>		Optional. The parameters to use.	Map<String, Object>

Returns

Return Type	Description
CypherQueryResult	a `CypherQueryResult`.

Exception Payloads

Payload Class	Description
MuleException	if anything goes wrong with the operation.

<neo4j:set-autoindexing-status>

This method is deprecated.
since Neo4j 2.0.0

Enable or disable node autoindexing.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
status		An Neo4jConnector#AutoIndexingStatus.	Neo4jConnector.AutoIndexingStatus	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
baseUri	http://localhost:7474/db/data	Optional. The base URI of the Neo4j server API.	String	/	UTF-8

Exception Payloads

Payload Class	Description
MuleException	if anything goes wrong with the operation.

<neo4j:set-node-labels>

Set labels of a Node.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
node		The `Node` to set labels of.	Node	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
baseUri	http://localhost:7474/db/data	Optional. The base URI of the Neo4j server API.	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<neo4j:labels>		A List of labels to set.	List<String>

Exception Payloads

Payload Class	Description
MuleException	if anything goes wrong with the operation.

<neo4j:set-node-properties>

Set the properties of a Node.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
node		The `Node` to set properties on.	Node	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
baseUri	http://localhost:7474/db/data	Optional. The base URI of the Neo4j server API.	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<neo4j:properties>		The properties of the node.	Map<String, Object>

Exception Payloads

Payload Class	Description
MuleException	if anything goes wrong with the operation.

<neo4j:set-node-property>

Set a property of a Node.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
node		The `Node` to set the property on.	Node	/
key		The key of the property.	String	/	UTF-8
value		The value of the property.	Object	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
baseUri	http://localhost:7474/db/data	Optional. The base URI of the Neo4j server API.	String	/	UTF-8

Exception Payloads

Payload Class	Description
MuleException	if anything goes wrong with the operation.

<neo4j:set-relationship-properties>

Set the properties of a Relationship.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
relationship		The `Relationship` to set properties on.	Relationship	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
baseUri	http://localhost:7474/db/data	Optional. The base URI of the Neo4j server API.	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<neo4j:properties>		The properties to set.	Map<String, Object>

Exception Payloads

Payload Class	Description
MuleException	if anything goes wrong with the operation.

<neo4j:set-relationship-property>

Set one property of a Relationship.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
relationship		The `Relationship` to set a property on.	Relationship	/
key		The property key.	String	/	UTF-8
value		The property value.	Object	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
baseUri	http://localhost:7474/db/data	Optional. The base URI of the Neo4j server API.	String	/	UTF-8

Exception Payloads

Payload Class	Description
MuleException	if anything goes wrong with the operation.

<neo4j:traverse-for-fullpaths>

Perform a node traversal, returning Fullpath instances.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
node		The start `Node`.	Node	/
order		The order to visit the nodes.	TraversalQuery.Order	/
uniqueness		How uniquess should be calculated.	TraversalQuery.Uniqueness	/
maxDepth		Optional. The maximum depth from the start node after which results must be pruned.	Integer	/
returnFilter		Optional. A filter that determines if the current position should be included in the result.	TraversalScript	/
pruneEvaluator		Optional. An evaluator that determines of traversal should stop or continue.	TraversalScript	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
baseUri	http://localhost:7474/db/data	Optional. The base URI of the Neo4j server API.	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<neo4j:relationships>		Optional. The relationship types and directions that must be followed.	List<RelationshipQuery>

Returns

Return Type	Description
Collection<Fullpath>	a Collection of `Fullpath`, never null but potentially empty.

Exception Payloads

Payload Class	Description
MuleException	if anything goes wrong with the operation.

<neo4j:traverse-for-fullpaths-with-paging>

Perform a paged node traversal, dispatching Fullpath instances to the rest of the flow.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
node		The start `Node`.	Node	/
order		The order to visit the nodes.	TraversalQuery.Order	/
uniqueness		How uniquess should be calculated.	TraversalQuery.Uniqueness	/
maxDepth		Optional. The maximum depth from the start node after which results must be pruned.	Integer	/
returnFilter		Optional. A filter that determines if the current position should be included in the result.	TraversalScript	/
pruneEvaluator		Optional. An evaluator that determines of traversal should stop or continue.	TraversalScript	/
pageSize	50	Optional. The size of the result page.	int	/
leaseTimeSeconds	60	Optional. The time during which the paged results will be accessible.	int	/
muleEvent		The MuleEvent being processed.	MuleEvent	/
sourceCallback		The SourceCallback invoked for each result page.	SourceCallback	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
baseUri	http://localhost:7474/db/data	Optional. The base URI of the Neo4j server API.	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<neo4j:relationships>		Optional. The relationship types and directions that must be followed.	List<RelationshipQuery>

Returns

Return Type	Description
void	a Collection of `Node`, never null but potentially empty.

Exception Payloads

Payload Class	Description
MuleException	if anything goes wrong with the operation.

<neo4j:traverse-for-nodes>

Perform a node traversal, returning Node instances.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
node		The start `Node`.	Node	/
order		The order to visit the nodes.	TraversalQuery.Order	/
uniqueness		How uniquess should be calculated.	TraversalQuery.Uniqueness	/
maxDepth		Optional. The maximum depth from the start node after which results must be pruned.	Integer	/
returnFilter		Optional. A filter that determines if the current position should be included in the result.	TraversalScript	/
pruneEvaluator		Optional. An evaluator that determines of traversal should stop or continue.	TraversalScript	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
baseUri	http://localhost:7474/db/data	Optional. The base URI of the Neo4j server API.	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<neo4j:relationships>		Optional. The relationship types and directions that must be followed.	List<RelationshipQuery>

Returns

Return Type	Description
Collection<Node>	a Collection of `Node`, never null but potentially empty.

Exception Payloads

Payload Class	Description
MuleException	if anything goes wrong with the operation.

<neo4j:traverse-for-nodes-with-paging>

Perform a paged node traversal, dispatching Node instances to the rest of the flow.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
node		The start `Node`.	Node	/
order		The order to visit the nodes.	TraversalQuery.Order	/
uniqueness		How uniquess should be calculated.	TraversalQuery.Uniqueness	/
maxDepth		Optional. The maximum depth from the start node after which results must be pruned.	Integer	/
returnFilter		Optional. A filter that determines if the current position should be included in the result.	TraversalScript	/
pruneEvaluator		Optional. An evaluator that determines of traversal should stop or continue.	TraversalScript	/
pageSize	50	Optional. The size of the result page.	int	/
leaseTimeSeconds	60	Optional. The time during which the paged results will be accessible.	int	/
muleEvent		The MuleEvent being processed.	MuleEvent	/
sourceCallback		The SourceCallback invoked for each result page.	SourceCallback	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
baseUri	http://localhost:7474/db/data	Optional. The base URI of the Neo4j server API.	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<neo4j:relationships>		Optional. The relationship types and directions that must be followed.	List<RelationshipQuery>

Returns

Return Type	Description
void	a Collection of `Node`, never null but potentially empty.

Exception Payloads

Payload Class	Description
MuleException	if anything goes wrong with the operation.

<neo4j:traverse-for-path-with-algorithm>

Traverse nodes with a particular algorithm, returning the first successful path found.

XML Sample

INCLUDE_ERROR

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
fromNode		The `Node` where traversal should start.	Node	/
toNode		The `Node` where traversal should end.	Node	/
algorithm		The `PathQuery.Algorithm` to use for the traversal.	PathQuery.Algorithm	/
relationshipType		The type of relationship to traverse.	String	/	UTF-8
maxDepth	1	Optional. The maximum depth from the start node below which traversal must stop.	int	/
costProperty		Optional. The property that contains the cost of traversal.	String	/	UTF-8
defaultCost		Optional. The default cost of the traversal.	Double	/
failIfNotFound	false	Optional. If true, an exception will be thrown if no path can be found, otherwise null will be returned.	boolean	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
baseUri	http://localhost:7474/db/data	Optional. The base URI of the Neo4j server API.	String	/	UTF-8

Returns

Return Type	Description
PathQueryResult	a single `PathQueryResult` instance.

Exception Payloads

Payload Class	Description
MuleException	if anything goes wrong with the operation.

<neo4j:traverse-for-paths>

Perform a node traversal, returning Path instances.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
node		The start `Node`.	Node	/
order		The order to visit the nodes.	TraversalQuery.Order	/
uniqueness		How uniquess should be calculated.	TraversalQuery.Uniqueness	/
maxDepth		Optional. The maximum depth from the start node after which results must be pruned.	Integer	/
returnFilter		Optional. A filter that determines if the current position should be included in the result.	TraversalScript	/
pruneEvaluator		Optional. An evaluator that determines of traversal should stop or continue.	TraversalScript	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
baseUri	http://localhost:7474/db/data	Optional. The base URI of the Neo4j server API.	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<neo4j:relationships>		Optional. The relationship types and directions that must be followed.	List<RelationshipQuery>

Returns

Return Type	Description
Collection<Path>	a Collection of `Path`, never null but potentially empty.

Exception Payloads

Payload Class	Description
MuleException	if anything goes wrong with the operation.

<neo4j:traverse-for-paths-with-algorithm>

Traverse nodes with a particular algorithm, returning all the successful paths found.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
fromNode		The `Node` where traversal should start.	Node	/
toNode		The `Node` where traversal should end.	Node	/
algorithm		The `PathQuery.Algorithm` to use for the traversal.	PathQuery.Algorithm	/
relationshipType		The type of relationship to traverse.	String	/	UTF-8
maxDepth	1	Optional. The maximum depth from the start node below which traversal must stop.	int	/
costProperty		Optional. The property that contains the cost of traversal.	String	/	UTF-8
defaultCost		Optional. The default cost of the traversal.	Double	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
baseUri	http://localhost:7474/db/data	Optional. The base URI of the Neo4j server API.	String	/	UTF-8

Returns

Return Type	Description
Collection<PathQueryResult>	a Collection of `PathQueryResult` instances, never null but potentially empty.

Exception Payloads

Payload Class	Description
MuleException	if anything goes wrong with the operation.

<neo4j:traverse-for-paths-with-paging>

Perform a paged node traversal, dispatching Path instances to the rest of the flow.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
node		The start `Node`.	Node	/
order		The order to visit the nodes.	TraversalQuery.Order	/
uniqueness		How uniquess should be calculated.	TraversalQuery.Uniqueness	/
maxDepth		Optional. The maximum depth from the start node after which results must be pruned.	Integer	/
returnFilter		Optional. A filter that determines if the current position should be included in the result.	TraversalScript	/
pruneEvaluator		Optional. An evaluator that determines of traversal should stop or continue.	TraversalScript	/
pageSize	50	Optional. The size of the result page.	int	/
leaseTimeSeconds	60	Optional. The time during which the paged results will be accessible.	int	/
muleEvent		The MuleEvent being processed.	MuleEvent	/
sourceCallback		The SourceCallback invoked for each result page.	SourceCallback	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
baseUri	http://localhost:7474/db/data	Optional. The base URI of the Neo4j server API.	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<neo4j:relationships>		Optional. The relationship types and directions that must be followed.	List<RelationshipQuery>

Returns

Return Type	Description
void	a Collection of `Node`, never null but potentially empty.

Exception Payloads

Payload Class	Description
MuleException	if anything goes wrong with the operation.

<neo4j:traverse-for-relationships>

Perform a node traversal, returning Relationship instances.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
node		The start `Node`.	Node	/
order		The order to visit the nodes.	TraversalQuery.Order	/
uniqueness		How uniquess should be calculated.	TraversalQuery.Uniqueness	/
maxDepth		Optional. The maximum depth from the start node after which results must be pruned.	Integer	/
returnFilter		Optional. A filter that determines if the current position should be included in the result.	TraversalScript	/
pruneEvaluator		Optional. An evaluator that determines of traversal should stop or continue.	TraversalScript	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
baseUri	http://localhost:7474/db/data	Optional. The base URI of the Neo4j server API.	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<neo4j:relationships>		Optional. The relationship types and directions that must be followed.	List<RelationshipQuery>

Returns

Return Type	Description
Collection<Relationship>	a Collection of `Relationship`, never null but potentially empty.

Exception Payloads

Payload Class	Description
MuleException	if anything goes wrong with the operation.

<neo4j:traverse-for-relationships-with-paging>

Perform a paged node traversal, dispatching Relationship instances to the rest of the flow.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
node		The start `Node`.	Node	/
order		The order to visit the nodes.	TraversalQuery.Order	/
uniqueness		How uniquess should be calculated.	TraversalQuery.Uniqueness	/
maxDepth		Optional. The maximum depth from the start node after which results must be pruned.	Integer	/
returnFilter		Optional. A filter that determines if the current position should be included in the result.	TraversalScript	/
pruneEvaluator		Optional. An evaluator that determines of traversal should stop or continue.	TraversalScript	/
pageSize	50	Optional. The size of the result page.	int	/
leaseTimeSeconds	60	Optional. The time during which the paged results will be accessible.	int	/
muleEvent		The MuleEvent being processed.	MuleEvent	/
sourceCallback		The SourceCallback invoked for each result page.	SourceCallback	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
baseUri	http://localhost:7474/db/data	Optional. The base URI of the Neo4j server API.	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<neo4j:relationships>		Optional. The relationship types and directions that must be followed.	List<RelationshipQuery>

Returns

Return Type	Description
void	a Collection of `Node`, never null but potentially empty.

Exception Payloads

Payload Class	Description
MuleException	if anything goes wrong with the operation.