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

Constructor Summary

Constructors

Constructor and Description
QueryMetaData(com.couchbase.client.core.api.query.CoreQueryMetaData internal)

Method Summary

Modifier and Type	Method and Description
String	clientContextId() Returns the client context identifier string set on the query request.
Optional<QueryMetrics>	metrics() Returns the QueryMetrics as returned by the query engine if enabled.
Optional<JsonObject>	profile() Returns the profiling information returned by the query engine which is then decoded to JsonObject
Optional<byte[]>	profileBytes() Returns a byte array containing the profiling information returned by the query engine, or an empty optional if no profiling information is available.
String	requestId() Returns the request identifier string of the query request
Optional<JsonObject>	signature() Returns the signature returned by the query engine, parsed as a JsonObject, or an empty optional if no signature is available.
Optional<byte[]>	signatureBytes() Returns a byte array containing the signature returned by the query engine, or an empty optional if no signature is available.
QueryStatus	status() Returns the raw query execution status as returned by the query engine
List<QueryWarning>	warnings() Returns any warnings returned by the query engine, as a JsonArray.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

QueryMetaData

@Stability.Internal
public QueryMetaData(com.couchbase.client.core.api.query.CoreQueryMetaData internal)

Method Detail

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 returned by the query engine, parsed as a JsonObject, or an empty optional if no signature is available.

A signature describes the "shape" of the query results.

For cases where the signature is not known to be a JSON Object, please use signatureBytes() instead.

Throws:

com.couchbase.client.core.error.DecodingFailureException - if the signature is not a JSON Object.

signatureBytes

@Stability.Uncommitted
public Optional<byte[]> signatureBytes()

Returns a byte array containing the signature returned by the query engine, or an empty optional if no signature is available.

The byte array contains JSON describing the "shape" of the query results. For most queries it's a JSON Object, but it can be any JSON type.

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:

com.couchbase.client.core.error.DecodingFailureException - when the profile cannot be decoded successfully

profileBytes

public Optional<byte[]> profileBytes()

Returns a byte array containing the profiling information returned by the query engine, or an empty optional if no profiling information is available.

The byte array contains a JSON Object.

metrics

public Optional<QueryMetrics> metrics()

Returns the QueryMetrics as returned by the query engine if enabled.

Throws:

com.couchbase.client.core.error.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:

com.couchbase.client.core.error.DecodingFailureException - when the warnings cannot be decoded successfully