Class GenericQueryResponse
java.lang.Object
com.couchbase.client.core.message.AbstractCouchbaseResponse
com.couchbase.client.core.message.query.GenericQueryResponse
- All Implemented Interfaces:
CouchbaseMessage
,CouchbaseResponse
public class GenericQueryResponse extends AbstractCouchbaseResponse
The base response for Query (N1QL) requests. Response is divided into sub-sections, each of which
can be asynchronously fed. They are represented as
Observable
, most of them of
ByteBuf
. Note that it is important that these streams are consumed and their ByteBuf released.
In order to reuse the values of a section but still correctly release the ByteBuf, the best is to
convert them into an appropriate gc-able value, release the buffer and cache the resulting stream.
If one isn't interested in a particular sub-section, it should still be released by subscribing a
Buffers.BYTE_BUF_RELEASER
to its stream.-
Constructor Summary
Constructors Constructor Description GenericQueryResponse(rx.Observable<ByteBuf> errors, rx.Observable<ByteBuf> rows, rx.Observable<ByteBuf> signature, rx.Observable<String> queryStatus, rx.Observable<ByteBuf> info, rx.Observable<ByteBuf> profileInfo, CouchbaseRequest request, ResponseStatus status, String requestId, String clientRequestId)
-
Method Summary
Modifier and Type Method Description String
clientRequestId()
rx.Observable<ByteBuf>
errors()
If there were errors and/or warnings while executing the query, contains aByteBuf
for each error and each warning.rx.Observable<ByteBuf>
info()
Contains a singleByteBuf
representing the JSON object of query execution metrics (or empty if metrics haven't been activated).rx.Observable<ByteBuf>
profileInfo()
Contains a singleByteBuf
representing the JSON object of query profile information (or empty if profile haven't been activated).rx.Observable<String>
queryStatus()
Contains a single String denoting the status of the query (success, running, errors, completed, stopped, timeout, fatal).String
requestId()
rx.Observable<ByteBuf>
rows()
Contains oneByteBuf
for each result item returned by the server.rx.Observable<ByteBuf>
signature()
Contains a singleByteBuf
representing the N1QL json signature of the results.Methods inherited from class com.couchbase.client.core.message.AbstractCouchbaseResponse
creationTime, request, status, statusDetails, statusDetails, toString
-
Constructor Details
-
GenericQueryResponse
public GenericQueryResponse(rx.Observable<ByteBuf> errors, rx.Observable<ByteBuf> rows, rx.Observable<ByteBuf> signature, rx.Observable<String> queryStatus, rx.Observable<ByteBuf> info, rx.Observable<ByteBuf> profileInfo, CouchbaseRequest request, ResponseStatus status, String requestId, String clientRequestId)
-
-
Method Details
-
rows
Contains oneByteBuf
for each result item returned by the server. Each item is a JSON object. -
signature
Contains a singleByteBuf
representing the N1QL json signature of the results. May not appear at all if there are no results (in case of fatal errors for example). -
errors
If there were errors and/or warnings while executing the query, contains aByteBuf
for each error and each warning. These are JSON objects, that should at least contain a 'msg' and a 'code'. -
queryStatus
-
info
Contains a singleByteBuf
representing the JSON object of query execution metrics (or empty if metrics haven't been activated). -
profileInfo
Contains a singleByteBuf
representing the JSON object of query profile information (or empty if profile haven't been activated). -
requestId
- Returns:
- the UUID for this request, can be used on the server side for tracing.
-
clientRequestId
- Returns:
- the client-provided identifier if provided in the request, empty string otherwise.
-