ExecuteGraphQueryRecord

Description:

This uses FlowFile records as input to perform graph mutations. Each record is associated with an individual query/mutation, and a FlowFile will be output for each successful operation. Failed records will be sent as a single FlowFile to the failure relationship.

Tags:

graph, gremlin, 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
Client Serviceclient-serviceController Service API:
GraphClientService
Implementations: OpenCypherClientService
Neo4JCypherClientService
GremlinClientService
The graph client service for connecting to a graph database.
Record Readerreader-serviceController Service API:
RecordReaderFactory
Implementations: Syslog5424Reader
CEFReader
ReaderLookup
CiscoEmblemSyslogMessageReader
CSVReader
GrokReader
SyslogReader
JsonTreeReader
JsonPathReader
XMLReader
AvroReader
JASN1Reader
ExcelReader
ParquetReader
EBCDICRecordReader
WindowsEventLogReader
IPFIXReader
ScriptedReader
The record reader to use with this processor.
Failed Record Writerwriter-serviceController Service API:
RecordSetWriterFactory
Implementations: JsonRecordSetWriter
ParquetRecordSetWriter
CSVRecordSetWriter
ScriptedRecordSetWriter
XMLRecordSetWriter
FreeFormTextRecordSetWriter
AvroRecordSetWriter
RecordSetWriterLookup
The record writer to use for writing failed records.
Graph Record Scriptrecord-scriptScript to perform the business logic on graph, using flow file attributes and custom properties as variable-value pairs in its logic.
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)

Dynamic Properties:

Supports Sensitive Dynamic Properties: No

Dynamic Properties allow the user to specify both the name and value of a property.

NameValueDescription
A dynamic property to be used as a parameter in the graph scriptThe variable name to be setUses a record path to set a variable as a parameter in the graph script
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)

Relationships:

NameDescription
responseThe response object from the graph server.
failureFlow files that fail to interact with graph server.
originalOriginal flow files that successfully interacted with graph server.

Reads Attributes:

None specified.

Writes Attributes:

NameDescription
graph.operations.tookThe amount of time it took to execute all of the graph operations.
record.countThe number of records unsuccessfully processed (written on FlowFiles routed to the 'failure' relationship.

State management:

This component does not store state.

Restricted:

This component is not restricted.

Input requirement:

This component requires an incoming relationship.

System Resource Considerations:

None specified.