/AWS1/CL_NEG=>EXECUTEQUERY()¶
About ExecuteQuery¶
Execute an openCypher query.
When invoking this operation in a Neptune Analytics cluster, the IAM user or role making the request must have a policy attached that allows one of the following IAM actions in that cluster, depending on the query:
-
neptune-graph:ReadDataViaQuery
-
neptune-graph:WriteDataViaQuery
-
neptune-graph:DeleteDataViaQuery
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_GRAPHIDENTIFIER TYPE /AWS1/NEGGRAPHIDENTIFIER /AWS1/NEGGRAPHIDENTIFIER¶
The unique identifier of the Neptune Analytics graph.
IV_QUERYSTRING TYPE /AWS1/NEGSTRING /AWS1/NEGSTRING¶
The query string to be executed.
IV_LANGUAGE TYPE /AWS1/NEGQUERYLANGUAGE /AWS1/NEGQUERYLANGUAGE¶
The query language the query is written in. Currently only openCypher is supported.
Optional arguments:¶
IT_PARAMETERS TYPE /AWS1/CL_RT_DOCUMENT=>TT_MAP TT_MAP¶
The data parameters the query can use in JSON format. For example: {"name": "john", "age": 20}. (optional)
IV_PLANCACHE TYPE /AWS1/NEGPLANCACHETYPE /AWS1/NEGPLANCACHETYPE¶
Query plan cache is a feature that saves the query plan and reuses it on successive executions of the same query. This reduces query latency, and works for both
READandUPDATEqueries. The plan cache is an LRU cache with a 5 minute TTL and a capacity of 1000.
IV_EXPLAINMODE TYPE /AWS1/NEGEXPLAINMODE /AWS1/NEGEXPLAINMODE¶
The explain mode parameter returns a query explain instead of the actual query results. A query explain can be used to gather insights about the query execution such as planning decisions, time spent on each operator, solutions flowing etc.
IV_QUERYTIMEOUTMILLISECONDS TYPE /AWS1/NEGINTEGER /AWS1/NEGINTEGER¶
Specifies the query timeout duration, in milliseconds. (optional)