ExecuteGraphQuery

Description:

This processor is designed to execute queries in either the Cypher query language or the Tinkerpop Gremlin DSL. It delegates most of the logic to a configured client service that handles the interaction with the remote data source. All of the output is written out as JSON data.

Additional Details...

Tags:

cypher, neo4j, graph, network, insert, update, delete, put, get, node, relationship, connection, executor, gremlin, tinkerpop

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
Client Servicegraph-client-serviceController Service API:
GraphClientService
Implementations: OpenCypherClientService
Neo4JCypherClientService
GremlinClientService
The graph client service for connecting to the graph database.
Graph Querygraph-querySpecifies the graph query. If it is left blank, the processor will attempt to get the query from body.
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)

Relationships:

NameDescription
successSuccessful FlowFiles are routed to this relationship
failureFailed FlowFiles are routed to this relationship
originalIf there is an input flowfile, the original input flowfile will be written to this relationship if the operation succeeds.

Reads Attributes:

None specified.

Writes Attributes:

NameDescription
graph.error.messageGraphDB error message
graph.labels.addedNumber of labels added
graph.nodes.createdNumber of nodes created
graph.nodes.deletedNumber of nodes deleted
graph.properties.setNumber of properties set
graph.relations.createdNumber of relationships created
graph.relations.deletedNumber of relationships deleted
graph.rows.returnedNumber of rows returned
query.tookThe amount of time in milliseconds that the querytook to execute.

State management:

This component does not store state.

Restricted:

This component is not restricted.

Input requirement:

This component allows an incoming relationship.

System Resource Considerations:

None specified.