com.couchbase.client.java.query

Class N1qlParams

java.lang.Object

com.couchbase.client.java.query.N1qlParams

All Implemented Interfaces:

Serializable

public class N1qlParams
extends Object
implements Serializable

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

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

Since:

2.1

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
N1qlParams	adhoc(boolean adhoc) Allows to specify if this query is adhoc or not.
static N1qlParams	build() Start building a N1qlParams, allowing to customize an N1QL request.
N1qlParams	consistency(ScanConsistency consistency) Sets scan consistency.
boolean	equals(Object o)
int	hashCode()
boolean	hasServerSideTimeout() Helper method to check if a custom server side timeout has been applied on the params.
void	injectParams(JsonObject queryJson) Modifies the given N1QL query (as a JsonObject) to reflect these N1qlParams.
boolean	isAdhoc() True if this query is adhoc, false otherwise.
N1qlParams	maxParallelism(int maxParallelism) Allows to override the default maximum parallelism for the query execution on the server side.
N1qlParams	scanWait(long wait, TimeUnit unit) If the NOT_BOUNDED scan consistency has been chosen, does nothing.
N1qlParams	serverSideTimeout(long timeout, TimeUnit unit) Sets a maximum timeout for processing on the server side.
String	toString()
N1qlParams	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, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

injectParams

public void injectParams(JsonObject queryJson)

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

Parameters:

queryJson - the N1QL query

build

public static N1qlParams build()

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

Returns:

a new N1qlParams

serverSideTimeout

public N1qlParams 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 N1qlParams for chaining.

withContextId

public N1qlParams 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 N1qlParams for chaining.

consistency

public N1qlParams consistency(ScanConsistency consistency)

Sets scan consistency.

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

Returns:

this N1qlParams for chaining.

scanWait

public N1qlParams 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 N1qlParams for chaining.

maxParallelism

public N1qlParams maxParallelism(int maxParallelism)

Allows to override the default maximum parallelism for the query execution on the server side.

Parameters:

maxParallelism - the maximum parallelism for this query, 0 or negative values disable it.

Returns:

this N1qlParams for chaining.

adhoc

public N1qlParams adhoc(boolean adhoc)

Allows to specify if this query is adhoc or not.

If it is not adhoc (so performed often), the client will try to perform optimizations transparently based on the server capabilities, like preparing the statement and then executing a query plan instead of the raw query.

Parameters:

adhoc - if the query is adhoc, default is true (plain execution).

Returns:

this N1qlParams for chaining.

hasServerSideTimeout

public boolean hasServerSideTimeout()

Helper method to check if a custom server side timeout has been applied on the params.

Returns:

true if it has, false otherwise.

isAdhoc

public boolean isAdhoc()

True if this query is adhoc, false otherwise.

Returns:

true if adhoc false otherwise.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object