Contact Us 1-800-596-4880
  1. Homepage
  2. Neo4j Connector (4.0)

  3. Neo4j Connector Reference

All Connectors

Neo4j 4.0 Connector Reference

Anypoint Connector for Neo4j provides the capability to execute CQL statements and run basic operations, such as create, update, delete, and select nodes against a Neo4j Graph database instance.

Release Notes: Neo4j Connector Release Notes

Configurations

Config

Default configuration

Parameters

Name Type Description Default Value Required

Name

String

Name for this configuration. Connectors reference the configuration with this name.

x

Connection

Connection

The connection types to provide to this configuration.

x

Name

String

ID used to reference this configuration.

x

Expiration Policy

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.

Connection Types

Connection
Parameters
Name Type Description Default Value Required

Username

String

Username to authenticate against the proxy server.

x

Password

String

Password to authenticate against the proxy server.

x

BOLT URL

String

x

Reconnection

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Supported Operations

Operations

Create Node

<neo4j:create-node>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Label

String

x

Input

Any

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Error Mappings

Array of Error Mapping

Set of error mappings

Reconnection Strategy

Retry strategy in case of connectivity errors.

For Configurations

Throws

  • NEO4J:AUTHENTICATION_ERROR

  • NEO4J:CLIENT_ERROR

  • NEO4J:CONNECTION_ERROR

  • NEO4J:CONNECTIVITY

  • NEO4J:DATABASE_EXCEPTION

  • NEO4J:INCORRECT_CREDENTIALS

  • NEO4J:INVALID_SESSION

  • NEO4J:JSON_PROCESSING_ERROR

  • NEO4J:NEO4J_DRIVER_EXCEPTION

  • NEO4J:NO_SUCH_RECORD_EXCEPTION

  • NEO4J:PROTOCOL_EXCEPTION

  • NEO4J:REQUEST_FAILED

  • NEO4J:RETRY_EXHAUSTED

  • NEO4J:SECURITY_EXCEPTION

  • NEO4J:SERVICE_UNAVAILABLE_EXCEPTION

  • NEO4J:SESSION_EXPIRED_EXCEPTION

  • NEO4J:TRANSIENT_EXCEPTION

  • NEO4J:UNKNOWN_HOST

Delete Nodes

<neo4j:delete-nodes>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Label

String

x

Remove Relationships

Boolean

false

Parameters

Any

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Error Mappings

Array of Error Mapping

Set of error mappings

Reconnection Strategy

Retry strategy in case of connectivity errors.

For Configurations

Throws

  • NEO4J:AUTHENTICATION_ERROR

  • NEO4J:CLIENT_ERROR

  • NEO4J:CONNECTION_ERROR

  • NEO4J:CONNECTIVITY

  • NEO4J:DATABASE_EXCEPTION

  • NEO4J:INCORRECT_CREDENTIALS

  • NEO4J:INVALID_SESSION

  • NEO4J:JSON_PROCESSING_ERROR

  • NEO4J:NEO4J_DRIVER_EXCEPTION

  • NEO4J:NO_SUCH_RECORD_EXCEPTION

  • NEO4J:PROTOCOL_EXCEPTION

  • NEO4J:REQUEST_FAILED

  • NEO4J:RETRY_EXHAUSTED

  • NEO4J:SECURITY_EXCEPTION

  • NEO4J:SERVICE_UNAVAILABLE_EXCEPTION

  • NEO4J:SESSION_EXPIRED_EXCEPTION

  • NEO4J:TRANSIENT_EXCEPTION

  • NEO4J:UNKNOWN_HOST

Execute

<neo4j:execute>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Query

String

x

Input

Any

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Target Variable

String

Name of the variable that storesoperation’s output will be placed

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

For Configurations

Throws

  • NEO4J:AUTHENTICATION_ERROR

  • NEO4J:CLIENT_ERROR

  • NEO4J:CONNECTION_ERROR

  • NEO4J:CONNECTIVITY

  • NEO4J:DATABASE_EXCEPTION

  • NEO4J:INCORRECT_CREDENTIALS

  • NEO4J:INVALID_SESSION

  • NEO4J:JSON_PROCESSING_ERROR

  • NEO4J:NEO4J_DRIVER_EXCEPTION

  • NEO4J:NO_SUCH_RECORD_EXCEPTION

  • NEO4J:PROTOCOL_EXCEPTION

  • NEO4J:REQUEST_FAILED

  • NEO4J:RETRY_EXHAUSTED

  • NEO4J:SECURITY_EXCEPTION

  • NEO4J:SERVICE_UNAVAILABLE_EXCEPTION

  • NEO4J:SESSION_EXPIRED_EXCEPTION

  • NEO4J:TRANSIENT_EXCEPTION

  • NEO4J:UNKNOWN_HOST

Select Nodes

<neo4j:select-nodes>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Label

String

x

Input

Any

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Target Variable

String

Name of the variable that storesoperation’s output will be placed

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

For Configurations

Throws

  • NEO4J:AUTHENTICATION_ERROR

  • NEO4J:CLIENT_ERROR

  • NEO4J:CONNECTION_ERROR

  • NEO4J:CONNECTIVITY

  • NEO4J:DATABASE_EXCEPTION

  • NEO4J:INCORRECT_CREDENTIALS

  • NEO4J:INVALID_SESSION

  • NEO4J:JSON_PROCESSING_ERROR

  • NEO4J:NEO4J_DRIVER_EXCEPTION

  • NEO4J:NO_SUCH_RECORD_EXCEPTION

  • NEO4J:PROTOCOL_EXCEPTION

  • NEO4J:REQUEST_FAILED

  • NEO4J:RETRY_EXHAUSTED

  • NEO4J:SECURITY_EXCEPTION

  • NEO4J:SERVICE_UNAVAILABLE_EXCEPTION

  • NEO4J:SESSION_EXPIRED_EXCEPTION

  • NEO4J:TRANSIENT_EXCEPTION

  • NEO4J:UNKNOWN_HOST

Update Nodes

<neo4j:update-nodes>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Label

String

x

Parameters

Any

Set Parameters

Any

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Error Mappings

Array of Error Mapping

Set of error mappings

Reconnection Strategy

Retry strategy in case of connectivity errors.

For Configurations

Throws

  • NEO4J:AUTHENTICATION_ERROR

  • NEO4J:CLIENT_ERROR

  • NEO4J:CONNECTION_ERROR

  • NEO4J:CONNECTIVITY

  • NEO4J:DATABASE_EXCEPTION

  • NEO4J:INCORRECT_CREDENTIALS

  • NEO4J:INVALID_SESSION

  • NEO4J:JSON_PROCESSING_ERROR

  • NEO4J:NEO4J_DRIVER_EXCEPTION

  • NEO4J:NO_SUCH_RECORD_EXCEPTION

  • NEO4J:PROTOCOL_EXCEPTION

  • NEO4J:REQUEST_FAILED

  • NEO4J:RETRY_EXHAUSTED

  • NEO4J:SECURITY_EXCEPTION

  • NEO4J:SERVICE_UNAVAILABLE_EXCEPTION

  • NEO4J:SESSION_EXPIRED_EXCEPTION

  • NEO4J:TRANSIENT_EXCEPTION

  • NEO4J:UNKNOWN_HOST

Types

Reconnection

Configures a reconnection strategy for an operation.

Field Type Description Default Value Required

Fails Deployment

Boolean

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Reconnection Strategy

Reconnection strategy to use.

Reconnect

Configures a standard reconnection strategy, which specifies how often to reconnect and how many reconnection attempts the connector source or operation can make.

Field Type Description Default Value Required

Frequency

Number

How often to attempt to reconnect, in milliseconds.

Blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

Count

Number

How many reconnection attempts the Mule app can make.

Reconnect Forever

Configures a forever reconnection strategy by which the connector source or operation attempts to reconnect at a specified frequency for as long as the Mule app runs.

Field Type Description Default Value Required

Frequency

Number

How often to attempt to reconnect, in milliseconds.

Blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

Expiration Policy

Configures an expiration policy strategy.

Field Type Description Default Value Required

Max Idle Time

Number

Configures the maximum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Max Idle Time field.

Error Mapping

Field Type Description Default Value Required

Source

Enumeration, one of:

  • ANY

  • REDELIVERY_EXHAUSTED

  • TRANSFORMATION

  • EXPRESSION

  • SECURITY

  • CLIENT_SECURITY

  • SERVER_SECURITY

  • ROUTING

  • CONNECTIVITY

  • RETRY_EXHAUSTED

  • TIMEOUT

Target

String

x

Repeatable In Memory Stream

Configures the in-memory streaming strategy by which the request fails if the data exceeds the MAX buffer size. Always run performance tests to find the optimal buffer size for your specific use case.

Field Type Description Default Value Required

Initial Buffer Size

Number

Initial amount of memory to allocate to the data stream. If the streamed data exceeds this value, the buffer expands by Buffer Size Increment, with an upper limit of Max In Memory Size value.

Buffer Size Increment

Number

This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full.

Max Buffer Size

Number

Maximum size of the buffer. If the buffer size exceeds this value, Mule raises a STREAM_MAXIMUM_SIZE_EXCEEDED error. A value of less than or equal to 0 means no limit.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

Unit for the Initial Buffer Size, Buffer Size Increment, and Buffer Unit fields.

Repeatable File Store Stream

Configures the repeatable file-store streaming strategy by which Mule keeps a portion of the stream content in memory. If the stream content is larger than the configured buffer size, Mule backs up the buffer’s content to disk and then clears the memory.

Field Type Description Default Value Required

In Memory Size

Number

Maximum amount of memory that the stream can use for data. If the amount of memory exceeds this value, Mule buffers the content to disk. To optimize performance:

  • Configure a larger buffer size to avoid the number of times Mule needs to write the buffer on disk. This increases performance, but it also limits the number of concurrent requests your application can process, because it requires additional memory.

  • Configure a smaller buffer size to decrease memory load at the expense of response time.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

Unit for the In Memory Size field.
Back to top
View on GitHub