public class QueryRequest extends BaseRequest<QueryResponse> implements HttpRequest<QueryChunkHeader,QueryChunkRow,QueryChunkTrailer,QueryResponse>
| Constructor and Description |
|---|
QueryRequest(Duration timeout,
CoreContext ctx,
RetryStrategy retryStrategy,
Authenticator authenticator,
String statement,
byte[] query,
boolean idempotent,
String contextId,
RequestSpan span,
String bucket,
String scope) |
| Modifier and Type | Method and Description |
|---|---|
String |
bucket() |
Authenticator |
credentials() |
QueryResponse |
decode(ResponseStatus status,
QueryChunkHeader header,
Flux<QueryChunkRow> rows,
Mono<QueryChunkTrailer> trailer)
Decodes a chunked response into the response format.
|
com.couchbase.client.core.deps.io.netty.handler.codec.http.FullHttpRequest |
encode() |
boolean |
idempotent()
Returns if the given request is idempotent or not.
|
String |
name()
The unique name of the request, usually related to the type but not necessarily.
|
String |
operationId()
Returns a potentially non-unique identifier that is useful for tracing output.
|
static String |
queryContext(String bucket,
String scope)
Helper method to build the query context from bucket and scope.
|
String |
scope() |
Map<String,Object> |
serviceContext()
Returns contextual information for each individual service.
|
ServiceType |
serviceType()
The service type of this request.
|
String |
statement() |
String |
toString() |
absoluteTimeout, cancel, cancellationReason, cancelled, completed, context, createdAt, fail, failed, id, requestSpan, response, retryStrategy, succeed, succeeded, timeout, timeoutElapsedclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitabsoluteTimeout, cancel, cancellationReason, cancelled, completed, context, createdAt, fail, failed, id, requestSpan, response, retryStrategy, succeed, succeeded, timeout, timeoutElapsedpublic QueryRequest(Duration timeout, CoreContext ctx, RetryStrategy retryStrategy, Authenticator authenticator, String statement, byte[] query, boolean idempotent, String contextId, RequestSpan span, String bucket, String scope)
public static String queryContext(String bucket, String scope)
bucket - the name of the bucket.scope - the name of the scope.public com.couchbase.client.core.deps.io.netty.handler.codec.http.FullHttpRequest encode()
public QueryResponse decode(ResponseStatus status, QueryChunkHeader header, Flux<QueryChunkRow> rows, Mono<QueryChunkTrailer> trailer)
ChunkDecodabledecode in interface ChunkDecodable<QueryChunkHeader,QueryChunkRow,QueryChunkTrailer,QueryResponse>status - the http response status.header - the chunk header.rows - the chunk rows.trailer - the chunk trailer.public ServiceType serviceType()
RequestserviceType in interface Request<QueryResponse>public String statement()
public Authenticator credentials()
public String operationId()
RequestNote: might be null! It depends on the type of operation. It is also different from the unqiue operation ID that increments to provide additional context (i.e in query the context uuid, in kv the opaque value).
operationId in interface Request<QueryResponse>public boolean idempotent()
RequestBy default, this method always returns false for data consistency reasons. Only specific idempotent operations should override this default since it impacts retry handling quite a bit. DO NOT SET THIS TO TRUE ON MUTATING OPERATIONS!
idempotent in interface Request<QueryResponse>public String bucket()
public String scope()
public Map<String,Object> serviceContext()
RequestserviceContext in interface Request<QueryResponse>serviceContext in class BaseRequest<QueryResponse>public String name()
RequestThe default implementation is derived from the class name (i.e. FooRequest => foo), but if that does not match up it should be overridden in the actual class.
name in interface Request<QueryResponse>Copyright © 2021 Couchbase, Inc.. All rights reserved.