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.
com.couchbase.client.java.transactions

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.
CompletableFuture<QueryResult>	AsyncScope.query(String statement, QueryOptions options)	Performs a N1QL query with custom QueryOptions in a Scope.
QueryResult	Cluster.query(String statement, QueryOptions options)	Performs a query against the query (N1QL) services with custom options.
Mono<ReactiveQueryResult>	ReactiveCluster.query(String statement, QueryOptions options)	Performs a N1QL query with custom QueryOptions.
Mono<ReactiveQueryResult>	ReactiveScope.query(String statement, QueryOptions options)	Performs a N1QL query with custom QueryOptions in a Scope
QueryResult	Scope.query(String statement, QueryOptions options)	Performs a N1QL query with custom QueryOptions in a Scope

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)	Allows turning this request into a prepared statement query.
QueryOptions	QueryOptions.asTransaction()	Performs this as a single query transaction, with default options.
QueryOptions	QueryOptions.asTransaction(SingleQueryTransactionOptions options)	Performs this as a single query transaction.
QueryOptions	QueryOptions.clientContextId(String clientContextId)	Supports providing a custom client context ID for this query.
QueryOptions	QueryOptions.consistentWith(MutationState mutationState)	Sets the MutationTokens this query should be consistent with.
QueryOptions	QueryOptions.flexIndex(boolean flexIndex)	Tells the query engine to use a flex index (utilizing the search service).
QueryOptions	QueryOptions.maxParallelism(int maxParallelism)	Allows overriding the default maximum parallelism for the query execution on the server side.
QueryOptions	QueryOptions.metrics(boolean metrics)	Enables per-request metrics in the trailing section of the query.
QueryOptions	QueryOptions.parameters(JsonArray positional)	Sets positional parameters for this query.
QueryOptions	QueryOptions.parameters(JsonObject named)	Sets named parameters for this query.
QueryOptions	QueryOptions.pipelineBatch(int pipelineBatch)	Supports customizing the number of items execution operators can batch for fetch from the KV layer on the server.
QueryOptions	QueryOptions.pipelineCap(int pipelineCap)	Allows customizing the maximum number of items each execution operator can buffer between various operators on the server.
QueryOptions	QueryOptions.preserveExpiry(boolean preserveExpiry)	Tells the query engine to preserve expiration values set on any documents modified by this query.
QueryOptions	QueryOptions.profile(QueryProfile profile)	Customizes the server profiling level for this query.
static QueryOptions	QueryOptions.queryOptions()	Creates new QueryOptions with all default params set.
QueryOptions	QueryOptions.raw(String key, Object value)	Allows providing custom JSON key/value pairs for advanced usage.
QueryOptions	QueryOptions.readonly(boolean readonly)	Allows explicitly marking a query as being readonly and not mutating and documents on the server side.
QueryOptions	QueryOptions.scanCap(int scanCap)	Supports customizing the maximum buffered channel size between the indexer and the query service.
QueryOptions	QueryOptions.scanConsistency(QueryScanConsistency scanConsistency)	Customizes the consistency guarantees for this query.
QueryOptions	QueryOptions.scanWait(Duration wait)	Allows customizing how long the query engine is willing to wait until the index catches up to whatever scan consistency is asked for in this query.
QueryOptions	QueryOptions.serializer(JsonSerializer serializer)	Provides a custom JsonSerializer to be used for decoding the rows as they return from the server.

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

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

Modifier and Type	Method	Description
QueryOptions	TransactionQueryOptions.builder()