Skip to content

Executes an openCypher explain request

Description

Executes an openCypher explain request. See The openCypher explain feature for more information.

When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:ReadDataViaQuery IAM action in that cluster.

Note that the neptune-db:QueryLanguage:OpenCypher IAM condition key can be used in the policy document to restrict the use of openCypher queries (see Condition keys available in Neptune IAM data-access policy statements).

Usage

neptunedata_execute_open_cypher_explain_query(openCypherQuery,
  parameters, explainMode)

Arguments

  • openCypherQuery

    [required] The openCypher query string.

  • parameters

    The openCypher query parameters.

  • explainMode

    [required] The openCypher explain mode. Can be one of: static, dynamic, or details.

Value

A list with the following syntax:

list(
  results = raw
)

Request syntax

svc$execute_open_cypher_explain_query(
  openCypherQuery = "string",
  parameters = "string",
  explainMode = "static"|"dynamic"|"details"
)