Package com.couchbase.analytics.client.java

Class QueryOptions

java.lang.Object
com.couchbase.analytics.client.java.QueryOptions
public final class QueryOptions extends Object
Optional parameters for Queryable.executeQuery(String, Consumer) and Queryable.executeStreamingQuery(String, Consumer, Consumer).

  • Method Details

    • timeout

      public QueryOptions timeout(@Nullable Duration timeout)

    • clientContextId

      public QueryOptions clientContextId(@Nullable String clientContextId)

    • 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:

    • scanWait

      public QueryOptions scanWait(@Nullable Duration scanWait)

    • scanConsistency

      public QueryOptions scanConsistency(@Nullable ScanConsistency scanConsistency)

    • readOnly

      public QueryOptions readOnly(@Nullable Boolean readOnly)

    • maxRetries

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

    • 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.