Module com.couchbase.columnar.client.java

Package com.couchbase.columnar.client.java

Class QueryOptions

java.lang.Object

com.couchbase.columnar.client.java.QueryOptions

public final class QueryOptions
extends Object

Optional parameters for Queryable.executeQuery(String, Consumer) and Queryable.executeStreamingQuery(String, Consumer, Consumer).

Method Summary

Modifier and Type	Method	Description
QueryOptions	deserializer(Deserializer deserializer)	Sets the deserializer used by Row.as(java.lang.Class<T>) to convert query result rows into Java objects.
QueryOptions	parameters(List<?> positionalParameters)
QueryOptions	parameters(Map<String,?> namedParameters)
QueryOptions	priority(QueryPriority priority)
QueryOptions	raw(Map<String,?> raw)	Specifies arbitrary name-value pairs to include the query request JSON.
QueryOptions	readOnly(Boolean readOnly)
QueryOptions	scanConsistency(ScanConsistency scanConsistency)
QueryOptions	scanWait(Duration scanWait)
QueryOptions	timeout(Duration timeout)

Methods inherited from class java.lang.Object

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

Method Details

timeout

public QueryOptions timeout(@Nullable
 Duration timeout)

parameters

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

parameters

public QueryOptions 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.

deserializer

public QueryOptions deserializer(@Nullable
 Deserializer deserializer)

Sets the deserializer used by Row.as(java.lang.Class<T>) to convert query result rows into Java objects.

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

See Also:

• ClusterOptions.deserializer(Deserializer)

scanWait

public QueryOptions scanWait(@Nullable
 Duration scanWait)

priority

public QueryOptions priority(@Nullable
 QueryPriority priority)

scanConsistency

public QueryOptions scanConsistency(@Nullable
 ScanConsistency scanConsistency)

readOnly

public QueryOptions readOnly(@Nullable
 Boolean readOnly)

raw

@Experimental
public QueryOptions 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.