Uses of Class
com.couchbase.client.java.query.QueryOptions

Packages that use QueryOptions

Package	Description
com.couchbase.client.java	Holds all classes that are needed for the Couchbase Java SDK.
com.couchbase.client.java.query	Namespace for various query-service related classes.

Uses of QueryOptions in com.couchbase.client.java

Methods in com.couchbase.client.java with parameters of type QueryOptions

Modifier and Type	Method	Description
CompletableFuture<QueryResult>	AsyncCluster.query(String statement, QueryOptions options)	Performs a N1QL query with custom QueryOptions.
QueryResult	Cluster.query(String statement, QueryOptions options)	Performs a N1QL query with custom QueryOptions.
Mono<ReactiveQueryResult>	ReactiveCluster.query(String statement, QueryOptions options)	Performs a N1QL query with custom QueryOptions.

Uses of QueryOptions in com.couchbase.client.java.query

Methods in com.couchbase.client.java.query that return QueryOptions

Modifier and Type	Method	Description
QueryOptions	QueryOptions.adhoc(boolean adhoc)	If set to false, enables transparent prepared statement support.
QueryOptions	QueryOptions.clientContextId(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.
QueryOptions	QueryOptions.consistentWith(MutationToken... tokens)	Sets the MutationTokens this query should be consistent with.
QueryOptions	QueryOptions.consistentWith(List<MutationToken> tokens)	Sets the MutationTokens this query should be consistent with.
QueryOptions	QueryOptions.credentials(String user, String password)	Additional credentials for the query
QueryOptions	QueryOptions.maxParallelism(int maxParallelism)	Allows to override the default maximum parallelism for the query execution on the server side.
QueryOptions	QueryOptions.metricsDisabled(boolean metricsDisabled)	If set to true (false being the default), the metrics object will not be returned from N1QL and as a result be more efficient.
QueryOptions	QueryOptions.parameters(JsonArray positional)	Positional parameters if the query is parameterized with position numbers
QueryOptions	QueryOptions.parameters(JsonObject named)	Named parameters if the query is parameterized with custom names
QueryOptions	QueryOptions.pipelineBatch(int pipelineBatch)	Advanced: Controls the number of items execution operators can batch for Fetch from the KV.
QueryOptions	QueryOptions.pipelineCap(int pipelineCap)	Advanced: Maximum number of items each execution operator can buffer between various operators.
QueryOptions	QueryOptions.prepared(boolean prepared)	Set to true if the query is already prepared/to be prepared
QueryOptions	QueryOptions.profile(QueryProfile queryProfile)	Set the profiling information level for query execution
static QueryOptions	QueryOptions.queryOptions()
QueryOptions	QueryOptions.rawParams(String param, Object value)	Raw parameters for the query
QueryOptions	QueryOptions.readonlyEnabled(boolean readonlyEnabled)	If set to true, it will signal the query engine on the server that only non-data modifying requests are allowed.
QueryOptions	QueryOptions.scanCap(int scanCap)	Advanced: Maximum buffered channel size between the indexer client and the query service for index scans.
QueryOptions	QueryOptions.scanConsistency(ScanConsistency scanConsistency)	Scan consistency for the query
QueryOptions	QueryOptions.scanWait(Duration wait)	If the scan consistency has been chosen, does nothing.