Package com.couchbase.client.java.query

Class QueryMetaData

java.lang.Object
com.couchbase.client.java.query.QueryMetaData
public class QueryMetaData
extends Object
Stores any non-rows results related to the execution of a particular N1QL query.
Since:
1.0.0
Author:
Graham Pople

  • Method Details

    • requestId

      public String requestId()
      Returns the request identifier string of the query request

    • clientContextId

      public String clientContextId()
      Returns the client context identifier string set on the query request.

    • status

      public QueryStatus status()
      Returns the raw query execution status as returned by the query engine

    • signature

      public Optional<JsonObject> signature()
      Returns the signature as returned by the query engine which is then decoded to JsonObject

      It is returned as an Optional which will be empty if no signature information is available.

      Throws:
      DecodingFailureException - when the signature cannot be decoded successfully

    • profile

      public Optional<JsonObject> profile()
      Returns the profiling information returned by the query engine which is then decoded to JsonObject

      It is returned as an Optional which will be empty if no profile information is available.

      Throws:
      DecodingFailureException - when the profile cannot be decoded successfully

    • metrics

      public Optional<QueryMetrics> metrics()
      Returns the QueryMetrics as returned by the query engine if enabled.
      Throws:
      DecodingFailureException - when the metrics cannot be decoded successfully

    • warnings

      public List<QueryWarning> warnings()
      Returns any warnings returned by the query engine, as a JsonArray.

      It is returned as an Optional which will be empty if no warnings were returned

      Throws:
      DecodingFailureException - when the warnings cannot be decoded successfully

    • toString

      public String toString()
      Overrides:
      toString in class Object