Label: :IA_Function
Property: type: Query
Inherits from: Function

Executes any query statement with related query language to selected store's database and returns its results.


Key Description Default value Possible values
cypher The Cypher statement that has to be executed. any valid Cypher statement
gremlin The Gremlin statement that has to be executed. any valid Gremlin statement
params.{myParameter} Parameters that are to be passed to the query statement. a literal value
process Determines whether the query result should be processed to a set of nodes and relations. false true|false 0|1
sparql The Sparql statement that has to be executed. any valid Sparql statement
store The graph store against which the related statement is to be executed. application name of a configured store

All properties can also be passed as parameters via an incoming trigger. To do so, include a property key on the incoming trigger with a $ or # as a prefix.

Outgoing triggers

Type: success

Occurrence: When the CypherQuery function executes successfully,.

Additional event properties (besides the inherited properties):

Key Description Possible values
data array of data as it is returned by Neo4j array
meta meta information object
meta.columns array of columns returned in result array of strings
meta.cypher Cypher statement string
meta.sparql Sparql statement string
meta.gremlin Gremlin statement string
meta.memory memory used in bytes integer
meta.nodecount count of nodes returned integer
meta.params parameters and values used in the cypher query object
meta.processData status of processData flag integer
meta.relcount count of relations returned integer
meta.status true if Cypher executed successfully boolean
meta.store store against which the Cypher was executed string
meta.stats Neo4j query stats object
meta.timing timing of query in ms object
meta.timing.data Time to retrieve data from Neo4j integer
meta.timing.processing Time to process data into processed integer
meta.timing.total Total time to retrieve and process data integer
processed data after processing in case process: true object
processed.labels all node labels in the results array of strings
processed.nodes all nodes in the result array of nodes
processed.relations all relationships in the result array of relations
processed.reltypes all relation types array of strings
processed.private number of nodes /relations not being transferred to client integer