com.couchbase.client.java.query

Class DefaultN1qlQueryResult

java.lang.Object

com.couchbase.client.java.query.DefaultN1qlQueryResult

All Implemented Interfaces:

N1qlQueryResult, Iterable<N1qlQueryRow>

public class DefaultN1qlQueryResult
extends Object
implements N1qlQueryResult

Constructor Summary

Constructors

Constructor and Description
DefaultN1qlQueryResult(List<AsyncN1qlQueryRow> rows, Object signature, N1qlMetrics info, List<JsonObject> errors, Boolean finalSuccess, boolean parseSuccess, String requestId, String clientContextId) Create a default blocking representation of a query result.

Method Summary

Modifier and Type	Method and Description
List<N1qlQueryRow>	allRows()
String	clientContextId()
List<JsonObject>	errors()
boolean	finalSuccess() Denotes the success or failure of the query.
N1qlMetrics	info()
Iterator<N1qlQueryRow>	iterator()
boolean	parseSuccess()
String	requestId()
Iterator<N1qlQueryRow>	rows()
Object	signature()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

DefaultN1qlQueryResult

public DefaultN1qlQueryResult(List<AsyncN1qlQueryRow> rows,
                              Object signature,
                              N1qlMetrics info,
                              List<JsonObject> errors,
                              Boolean finalSuccess,
                              boolean parseSuccess,
                              String requestId,
                              String clientContextId)

Create a default blocking representation of a query result.

Parameters:

rows - the list of rows.

signature - the signature for rows.

info - the metrics.

errors - the list of errors and warnings.

finalSuccess - the definitive (but potentially delayed) result of the query.

parseSuccess - the intermediate result of the query

Method Detail

allRows

public List<N1qlQueryRow> allRows()

Specified by:

allRows in interface N1qlQueryResult

Returns:

the list of all N1qlQueryRow, the results of the query, if successful.

rows

public Iterator<N1qlQueryRow> rows()

Specified by:

rows in interface N1qlQueryResult

Returns:

an iterator over the list of all N1qlQueryRow, the results of the query, if successful.

signature

public Object signature()

Specified by:

signature in interface N1qlQueryResult

Returns:

an object representing the signature of the results, that can be used to learn about the common structure of each row. This signature is usually a JsonObject, but could also be any JSON-valid type like a boolean scalar, JsonArray…

info

public N1qlMetrics info()

Specified by:

info in interface N1qlQueryResult

Returns:

an object describing some metrics/info about the execution of the query.

parseSuccess

public boolean parseSuccess()

Specified by:

parseSuccess in interface N1qlQueryResult

Returns:

true if the query could be parsed, false if it short-circuited due to syntax/fatal error.

errors

public List<JsonObject> errors()

Specified by:

errors in interface N1qlQueryResult

Returns:

A list of errors or warnings encountered while executing the query.

finalSuccess

public boolean finalSuccess()

Description copied from interface: N1qlQueryResult

Denotes the success or failure of the query. It could fail slower than with N1qlQueryResult.parseSuccess(), for example if a fatal error comes up while streaming the results to the client. Receiving a (single) value for finalSuccess means the query is over.

Specified by:

finalSuccess in interface N1qlQueryResult

iterator

public Iterator<N1qlQueryRow> iterator()

Specified by:

iterator in interface Iterable<N1qlQueryRow>

requestId

public String requestId()

Specified by:

requestId in interface N1qlQueryResult

Returns:

the requestId generated by the server

clientContextId

public String clientContextId()

Specified by:

clientContextId in interface N1qlQueryResult

Returns:

the clientContextId that was set by the client (could be truncated to 64 bytes of UTF-8 chars)