com.couchbase.client.java.query

Class QueryParams

java.lang.Object

com.couchbase.client.java.query.QueryParams

public class QueryParams
extends Object

Parameter Object for queries that allows to fluently set most of the N1QL query parameters: - server side timeout - credentials - client context ID - scan consistency (with associated scan vector and/or scan wait if relevant)

Note that these are different from statement-related named parameters or positional parameters.

Since:

2.1

Method Summary

Modifier and Type	Method and Description
static QueryParams	build() Start building a QueryParams, allowing to customize an N1QL request.
QueryParams	consistency(ScanConsistency consistency) Sets scan consistency.
void	injectParams(JsonObject queryJson) Modifies the given N1QL query (as a JsonObject) to reflect these QueryParams.
QueryParams	scanWait(long wait, TimeUnit unit) If the NOT_BOUNDED scan consistency has been chosen, does nothing.
QueryParams	serverSideTimeout(long timeout, TimeUnit unit) Sets a maximum timeout for processing on the server side.
QueryParams	withContextId(String clientContextId) Adds a client context ID to the request, that will be sent back in the response, allowing clients to meaningfully trace requests/responses when many are exchanged.

Methods inherited from class java.lang.Object

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

Method Detail

injectParams

public void injectParams(JsonObject queryJson)

Modifies the given N1QL query (as a JsonObject) to reflect these QueryParams.

Parameters:

queryJson - the N1QL query

build

public static QueryParams build()

Start building a QueryParams, allowing to customize an N1QL request.

Returns:

a new QueryParams

serverSideTimeout

public QueryParams serverSideTimeout(long timeout,
                                     TimeUnit unit)

Sets a maximum timeout for processing on the server side.

Parameters:

timeout - the duration of the timeout.

unit - the unit of the timeout, from nanoseconds to hours.

Returns:

this QueryParams for chaining.

withContextId

public QueryParams withContextId(String clientContextId)

Adds a client context ID to the request, that will be sent back in the response, allowing clients to meaningfully trace requests/responses when many are exchanged.

Parameters:

clientContextId - the client context ID (null to send none)

Returns:

this QueryParams for chaining.

consistency

public QueryParams consistency(ScanConsistency consistency)

Sets scan consistency.

Note that NOT_BOUNDED will unset the scanWait if it was set.

Returns:

this QueryParams for chaining.

scanWait

public QueryParams scanWait(long wait,
                            TimeUnit unit)

If the NOT_BOUNDED scan consistency has been chosen, does nothing.

Otherwise, sets the maximum time the client is willing to wait for an index to catch up to the vector timestamp in the request.

Parameters:

wait - the duration.

unit - the unit for the duration.

Returns:

this QueryParams for chaining.