Free MuleSoft CONNECT Keynote & Expo Pass Available!

Register now+
Nav

Neo4j Connector Reference

Default Configuration

Parameters

Name Type Description Default Value Required

Name

String

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

x

Connection

Connection

The connection types that can be provided to this configuration.

x

Expiration Policy

ExpirationPolicy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. The runtime purges the instances when it sees fit.

Connection Type

Parameters

Name Type Description Default Value Required

Username

String

x

Password

String

x

BOLT URL

String

x

REST 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.

Associated Operations

  • createNode

  • deleteNodes

  • execute

  • selectNodes

  • updateNodes

Operations

Create Node

<neo4j:create-node>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Label

String

x

Input

Binary

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

For Configurations

  • config

Throws

  • NEO4J:CONNECTIVITY

  • NEO4J:RETRY_EXHAUSTED

Delete Nodes

<neo4j:delete-nodes>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Label

String

x

Remove Relationships

Boolean

false

Parameters

Binary

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

For Configurations

  • config

Throws

  • NEO4J:CONNECTIVITY

  • NEO4J:RETRY_EXHAUSTED

Execute

<neo4j:execute>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Query

String

#[payload]

Input

Binary

Streaming Strategy

  • repeatable-in-memory-stream

  • repeatable-file-store-stream

  • non-repeatable-stream

Configure if repeatable streams should be used and their behavior.

Target Variable

String

The name of a variable on which the operation’s output is placed.

Target Value

String

An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type Binary

For Configurations

  • config

Throws

  • NEO4J:CONNECTIVITY

  • NEO4J:RETRY_EXHAUSTED

Select Nodes

<neo4j:select-nodes>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Label

String

x

Input

Binary

Target Variable

String

The name of a variable on which the operation’s output is placed.

Target Value

String

An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type Array of Object

For Configurations

  • config

Throws

  • NEO4J:CONNECTIVITY

  • NEO4J:RETRY_EXHAUSTED

Update Nodes

<neo4j:update-nodes>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Label

String

x

Parameters

Binary

Set Parameters

Binary

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

For Configurations

  • config

Throws

  • NEO4J:CONNECTIVITY

  • NEO4J:RETRY_EXHAUSTED

Types

Reconnection

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

  • reconnect

  • reconnect-forever

The reconnection strategy to use.

Reconnect

Field Type Description Default Value Required

Frequency

Number

How often (in milliseconds) to reconnect.

Count

Number

How many reconnection attempts to make.

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often (in milliseconds) to reconnect.

Expiration Policy

Field Type Description Default Value Required

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration.

Time Unit

Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS ** DAYS

A time unit that qualifies the maxIdleTime attribute.

Repeatable In Memory Stream

Field Type Description Default Value Required

Initial Buffer Size

Number

This is the amount of memory to allocate to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.

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

This is the maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower or equal to zero means no limit.

Buffer Unit

Enumeration, one of: BYTE KB MB GB

The unit in which all these attributes are expressed

Repeatable File Store Stream

Field Type Description Default Value Required

Max In Memory Size

Number

Defines the maximum memory that the stream should use to keep data in memory. If more memory is consumed, the connector starts to buffer the content on disk.

Buffer Unit

Enumeration, one of: BYTE KB MB GB

The unit in which maxInMemorySize is expressed