com.couchbase.client.java.query

Class DefaultAsyncN1qlQueryResult

java.lang.Object

com.couchbase.client.java.query.DefaultAsyncN1qlQueryResult

All Implemented Interfaces:

AsyncN1qlQueryResult

@InterfaceStability.Uncommitted
 @InterfaceAudience.Public
public class DefaultAsyncN1qlQueryResult
extends Object
implements AsyncN1qlQueryResult

The default implementation of an AsyncN1qlQueryResult.

Author:

Michael Nitschinger

Constructor Summary

Constructors

Constructor and Description
DefaultAsyncN1qlQueryResult(Observable<AsyncN1qlQueryRow> rows, Observable<Object> signature, Observable<N1qlMetrics> info, Observable<JsonObject> errors, Observable<Boolean> finalSuccess, boolean parsingSuccess, String requestId, String clientContextId)

Method Summary

Modifier and Type	Method and Description
String	clientContextId()
Observable<JsonObject>	errors()
Observable<Boolean>	finalSuccess() Asynchronously denotes the success or failure of the query.
Observable<N1qlMetrics>	info()
boolean	parseSuccess() Immediately denotes initial parsing success of the query.
String	requestId()
Observable<AsyncN1qlQueryRow>	rows()
Observable<Object>	signature()

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultAsyncN1qlQueryResult

public DefaultAsyncN1qlQueryResult(Observable<AsyncN1qlQueryRow> rows,
                                   Observable<Object> signature,
                                   Observable<N1qlMetrics> info,
                                   Observable<JsonObject> errors,
                                   Observable<Boolean> finalSuccess,
                                   boolean parsingSuccess,
                                   String requestId,
                                   String clientContextId)

Method Detail

rows

public Observable<AsyncN1qlQueryRow> rows()

Specified by:

rows in interface AsyncN1qlQueryResult

Returns:

an async stream of each row resulting from the query (empty if fatal errors occurred).

signature

public Observable<Object> signature()

Specified by:

signature in interface AsyncN1qlQueryResult

Returns:

an async single-item 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 Observable<N1qlMetrics> info()

Specified by:

info in interface AsyncN1qlQueryResult

Returns:

an async single item describing some metrics/info about the execution of the query.

finalSuccess

public Observable<Boolean> finalSuccess()

Description copied from interface: AsyncN1qlQueryResult

Asynchronously denotes the success or failure of the query. It could fail slower than with AsyncN1qlQueryResult.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 AsyncN1qlQueryResult

parseSuccess

public boolean parseSuccess()

Description copied from interface: AsyncN1qlQueryResult

Immediately denotes initial parsing success of the query.

As rows are processed, it could be that a late failure occurs. See AsyncN1qlQueryResult.finalSuccess() for the end of processing status.

Specified by:

parseSuccess in interface AsyncN1qlQueryResult

Returns:

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

errors

public Observable<JsonObject> errors()

Specified by:

errors in interface AsyncN1qlQueryResult

Returns:

an async stream of errors or warnings encountered while executing the query.

requestId

public String requestId()

Specified by:

requestId in interface AsyncN1qlQueryResult

Returns:

the requestId generated by the server

clientContextId

public String clientContextId()

Specified by:

clientContextId in interface AsyncN1qlQueryResult

Returns:

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