Neo4JCypherClientService

Description:

Provides a client service for managing connections to a Neo4J 4.X or newer database. Configuration information for the Neo4J driver that corresponds to most of the settings for this service can be found here: https://neo4j.com/docs/driver-manual/current/client-applications/#driver-configuration. This service was created as a result of the break in driver compatibility between Neo4J 3.X and 4.X and might be renamed in the future if and when Neo4J should break driver compatibility between 4.X and a future release.

Tags:

graph, neo4j, cypher

Properties:

In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.

Display NameAPI NameDefault ValueAllowable ValuesDescription
Neo4j Connection URLneo4j-connection-urlbolt://localhost:7687Neo4J endpoing to connect to.
Supports Expression Language: true (will be evaluated using Environment variables only)
Usernameneo4j-usernameUsername for accessing Neo4J
Supports Expression Language: true (will be evaluated using Environment variables only)
Passwordneo4j-passwordPassword for Neo4J user. A dummy non-blank password is required even if it disabled on the server.
Sensitive Property: true
Neo4J Max Connection Time Out (seconds)neo4j-max-connection-time-out5 secondsThe maximum time for establishing connection to the Neo4j
Supports Expression Language: true (will be evaluated using Environment variables only)
Neo4J Max Connection Pool Sizeneo4j-max-connection-pool-size100The maximum connection pool size for Neo4j.
Supports Expression Language: true (will be evaluated using Environment variables only)
Neo4J Max Connection Acquisition Timeoutneo4j-max-connection-acquisition-timeout60 secondThe maximum connection acquisition timeout.
Supports Expression Language: true (will be evaluated using Environment variables only)
Neo4J Idle Time Before Connection Testneo4j-idle-time-before-test60 secondsThe idle time before connection test.
Supports Expression Language: true (will be evaluated using Environment variables only)
Neo4J Max Connection Lifetimeneo4j-max-connection-lifetime3600 secondsThe maximum connection lifetime
Supports Expression Language: true (will be evaluated using Environment variables only)
SSL Trust Chain PEMSSL Trust Chain PEMNeo4J requires trust chains to be stored in a PEM file. If you want to use a custom trust chain rather than defaulting to the system trust chain, specify the path to a PEM file with the trust chain.
Supports Expression Language: true (will be evaluated using Environment variables only)

State management:

This component does not store state.

Restricted:

This component is not restricted.

System Resource Considerations:

None specified.