Package com.couchbase.analytics.client.java

Class CommonQueryOptions<SELF extends CommonQueryOptions<SELF>>

java.lang.Object

com.couchbase.analytics.client.java.CommonQueryOptions<SELF>

Direct Known Subclasses:

QueryOptions, StartQueryOptions

public class CommonQueryOptions<SELF extends CommonQueryOptions<SELF>>
extends Object

Optional parameters common to all methods that execute a query statement.

See Also:

• Queryable.startQuery(String, Consumer)
• Queryable.executeQuery(String, Consumer)
• Queryable.executeStreamingQuery(String, Consumer)

Method Summary

Modifier and Type	Method	Description
SELF	clientContextId(@Nullable String clientContextId)
SELF	maxRetries(@Nullable Integer maxRetries)	Limits the number of times a failed retriable request is retried.
SELF	parameters(@Nullable List<?> positionalParameters)
SELF	parameters(@Nullable Map<String,?> namedParameters)
SELF	raw(@Nullable Map<String,?> raw)	Specifies arbitrary name-value pairs to include the query request JSON.
SELF	readOnly(@Nullable Boolean readOnly)
SELF	scanConsistency(@Nullable ScanConsistency scanConsistency)
SELF	scanWait(@Nullable Duration scanWait)
SELF	timeout(@Nullable Duration timeout)	Sets the time limit for executing the query.

Methods inherited from class java.lang.Object

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

Method Details

timeout

public SELF timeout(@Nullable Duration timeout)

Sets the time limit for executing the query. If the query does not complete within this time, it is automatically canceled.

For Queryable.executeQuery(java.lang.String, java.util.function.Consumer<com.couchbase.analytics.client.java.QueryOptions>) and Queryable.executeStreamingQuery(java.lang.String, java.util.function.Consumer<com.couchbase.analytics.client.java.Row>, java.util.function.Consumer<com.couchbase.analytics.client.java.QueryOptions>), this is also the client-side request timeout.

A timeout is surfaced as:

• AnalyticsTimeoutException if the client notices the timeout first.
• QueryException if the server notices the timeout first, which is often the case when working with query handles returned from Queryable.startQuery(String).

If not specified, defaults to TimeoutOptions.queryTimeout(Duration).

clientContextId

public SELF clientContextId(@Nullable String clientContextId)

parameters

public SELF parameters(@Nullable Map<String,?> namedParameters)

parameters

public SELF parameters(@Nullable List<?> positionalParameters)

Implementation Note:

There must not be a varargs overload; that would introduce ambiguity, since a query can have a single parameter whose value is a list.

scanWait

public SELF scanWait(@Nullable Duration scanWait)

scanConsistency

public SELF scanConsistency(@Nullable ScanConsistency scanConsistency)

readOnly

public SELF readOnly(@Nullable Boolean readOnly)

maxRetries

@Experimental
public SELF maxRetries(@Nullable Integer maxRetries)

Limits the number of times a failed retriable request is retried.

If not specified, defaults to the cluster's default max retries.

See Also:

• ClusterOptions.maxRetries(Integer)

raw

@Experimental
public SELF raw(@Nullable Map<String,?> raw)

Specifies arbitrary name-value pairs to include the query request JSON.

Marked as "experimental" because this might not be supported by future client-server protocols. Let us know if you need to use this method, so we can consider extending the stable API to support your use case.