Module Values.ExecuteGremlinExplainQueryOutputSource

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. 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 one of the following IAM actions in that cluster, depending on the query: neptune-db:ReadDataViaQuery neptune-db:WriteDataViaQuery neptune-db:DeleteDataViaQuery Note that the neptune-db:QueryLanguage:Gremlin IAM condition key can be used in the policy document to restrict the use of Gremlin queries (see Condition keys available in Neptune IAM data-access policy statements).

Sourcetype nonrec t = {
  1. output : ReportAsText.t option;
    (*

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

    *)
}
Sourcetype nonrec error = [
  1. | `BadRequestException of BadRequestException.t
  2. | `CancelledByUserException of CancelledByUserException.t
  3. | `ClientTimeoutException of ClientTimeoutException.t
  4. | `ConcurrentModificationException of ConcurrentModificationException.t
  5. | `ConstraintViolationException of ConstraintViolationException.t
  6. | `FailureByQueryException of FailureByQueryException.t
  7. | `IllegalArgumentException of IllegalArgumentException.t
  8. | `InvalidArgumentException of InvalidArgumentException.t
  9. | `InvalidParameterException of InvalidParameterException.t
  10. | `MalformedQueryException of MalformedQueryException.t
  11. | `MemoryLimitExceededException of MemoryLimitExceededException.t
  12. | `MissingParameterException of MissingParameterException.t
  13. | `ParsingException of ParsingException.t
  14. | `PreconditionsFailedException of PreconditionsFailedException.t
  15. | `QueryLimitExceededException of QueryLimitExceededException.t
  16. | `QueryLimitException of QueryLimitException.t
  17. | `QueryTooLargeException of QueryTooLargeException.t
  18. | `TimeLimitExceededException of TimeLimitExceededException.t
  19. | `TooManyRequestsException of TooManyRequestsException.t
  20. | `UnsupportedOperationException of UnsupportedOperationException.t
  21. | `Unknown_operation_error of string * string option
]
Sourceval make : ?output:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `BadRequestException of BadRequestException.t | `CancelledByUserException of CancelledByUserException.t | `ClientTimeoutException of ClientTimeoutException.t | `ConcurrentModificationException of ConcurrentModificationException.t | `ConstraintViolationException of ConstraintViolationException.t | `FailureByQueryException of FailureByQueryException.t | `IllegalArgumentException of IllegalArgumentException.t | `InvalidArgumentException of InvalidArgumentException.t | `InvalidParameterException of InvalidParameterException.t | `MalformedQueryException of MalformedQueryException.t | `MemoryLimitExceededException of MemoryLimitExceededException.t | `MissingParameterException of MissingParameterException.t | `ParsingException of ParsingException.t | `PreconditionsFailedException of PreconditionsFailedException.t | `QueryLimitExceededException of QueryLimitExceededException.t | `QueryLimitException of QueryLimitException.t | `QueryTooLargeException of QueryTooLargeException.t | `TimeLimitExceededException of TimeLimitExceededException.t | `TooManyRequestsException of TooManyRequestsException.t | `Unknown_operation_error of string * string option | `UnsupportedOperationException of UnsupportedOperationException.t ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `BadRequestException of BadRequestException.t | `CancelledByUserException of CancelledByUserException.t | `ClientTimeoutException of ClientTimeoutException.t | `ConcurrentModificationException of ConcurrentModificationException.t | `ConstraintViolationException of ConstraintViolationException.t | `FailureByQueryException of FailureByQueryException.t | `IllegalArgumentException of IllegalArgumentException.t | `InvalidArgumentException of InvalidArgumentException.t | `InvalidParameterException of InvalidParameterException.t | `MalformedQueryException of MalformedQueryException.t | `MemoryLimitExceededException of MemoryLimitExceededException.t | `MissingParameterException of MissingParameterException.t | `ParsingException of ParsingException.t | `PreconditionsFailedException of PreconditionsFailedException.t | `QueryLimitExceededException of QueryLimitExceededException.t | `QueryLimitException of QueryLimitException.t | `QueryTooLargeException of QueryTooLargeException.t | `TimeLimitExceededException of TimeLimitExceededException.t | `TooManyRequestsException of TooManyRequestsException.t | `Unknown_operation_error of string * string option | `UnsupportedOperationException of UnsupportedOperationException.t ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval of_header_and_body : ('a * ReportAsText.t) -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Blob of ReportAsText.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t