NeptuneData / Client / execute_gremlin_explain_query

execute_gremlin_explain_query#

NeptuneData.Client.execute_gremlin_explain_query(**kwargs)#

Executes a Gremlin Explain query.

Amazon Neptune has added a Gremlin feature named explain that provides is a self-service tool for understanding the execution approach being taken by the Neptune engine for the query. You invoke it by adding an explain parameter to an HTTP call that submits a Gremlin query.

The explain feature provides information about the logical structure of query execution plans. You can use this information to identify potential evaluation and execution bottlenecks and to tune your query, as explained in Tuning Gremlin queries. You can also use query hints to improve query execution plans.

See also: AWS API Documentation

Request Syntax

response = client.execute_gremlin_explain_query(
    gremlinQuery='string'
)
Parameters:

gremlinQuery (string) –

[REQUIRED]

The Gremlin explain query string.

Return type:

dict

Returns:

Response Syntax

{
    'output': StreamingBody()
}

Response Structure

  • (dict) –

    • output (StreamingBody) –

      A text blob containing the Gremlin explain result, as described in Tuning Gremlin queries.

Exceptions

  • NeptuneData.Client.exceptions.QueryTooLargeException

  • NeptuneData.Client.exceptions.BadRequestException

  • NeptuneData.Client.exceptions.QueryLimitExceededException

  • NeptuneData.Client.exceptions.InvalidParameterException

  • NeptuneData.Client.exceptions.QueryLimitException

  • NeptuneData.Client.exceptions.ClientTimeoutException

  • NeptuneData.Client.exceptions.CancelledByUserException

  • NeptuneData.Client.exceptions.IllegalArgumentException

  • NeptuneData.Client.exceptions.TooManyRequestsException

  • NeptuneData.Client.exceptions.UnsupportedOperationException

  • NeptuneData.Client.exceptions.FailureByQueryException

  • NeptuneData.Client.exceptions.MemoryLimitExceededException

  • NeptuneData.Client.exceptions.PreconditionsFailedException

  • NeptuneData.Client.exceptions.MalformedQueryException

  • NeptuneData.Client.exceptions.ParsingException

  • NeptuneData.Client.exceptions.ConstraintViolationException

  • NeptuneData.Client.exceptions.TimeLimitExceededException

  • NeptuneData.Client.exceptions.InvalidArgumentException

  • NeptuneData.Client.exceptions.ConcurrentModificationException

  • NeptuneData.Client.exceptions.MissingParameterException