NeptuneData / Client / execute_open_cypher_explain_query

execute_open_cypher_explain_query#

NeptuneData.Client.execute_open_cypher_explain_query(**kwargs)#

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).

See also: AWS API Documentation

Request Syntax

response = client.execute_open_cypher_explain_query(
    openCypherQuery='string',
    parameters='string',
    explainMode='static'|'dynamic'|'details'
)
Parameters:

  • openCypherQuery (string) –

    [REQUIRED]

    The openCypher query string.

  • parameters (string) – The openCypher query parameters.

  • explainMode (string) –

    [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'results': StreamingBody()
}

Response Structure

  • (dict) –

    • results (StreamingBody) –

      A text blob containing the openCypher explain results.

Exceptions