QueryOptions
class QueryOptions (View source)
Methods
Sets the operation timeout in milliseconds.
Sets the mutation state to achieve consistency with for read your own writes (RYOW).
Sets the scan consistency.
Sets the maximum buffered channel size between the indexer client and the query service for index scans.
Sets the maximum number of items each execution operator can buffer between various operators.
Sets the number of items execution operators can batch for fetch from the KV service.
Sets the maximum number of index partitions, for computing aggregation in parallel.
Sets the query profile mode to use.
Sets whether or not this query is readonly.
Sets whether or not this query allowed to use FlexIndex (full text search integration).
Sets whether or not this query is adhoc.
Sets the named parameters for this query.
Sets the positional parameters for this query.
Sets any extra query parameters that the SDK does not provide an option for.
Sets the client context id for this query.
Sets whether or not to return metrics with the query.
Associate scope name with query
Associate scope qualifier (also known as query_context) with the query.
Details
QueryOptions
timeout(int $arg)
Sets the operation timeout in milliseconds.
QueryOptions
consistentWith(MutationState $arg)
Sets the mutation state to achieve consistency with for read your own writes (RYOW).
QueryOptions
scanConsistency(int $arg)
Sets the scan consistency.
QueryOptions
scanCap(int $arg)
Sets the maximum buffered channel size between the indexer client and the query service for index scans.
QueryOptions
pipelineCap(int $arg)
Sets the maximum number of items each execution operator can buffer between various operators.
QueryOptions
pipelineBatch(int $arg)
Sets the number of items execution operators can batch for fetch from the KV service.
QueryOptions
maxParallelism(int $arg)
Sets the maximum number of index partitions, for computing aggregation in parallel.
QueryOptions
profile(int $arg)
Sets the query profile mode to use.
QueryOptions
readonly(bool $arg)
Sets whether or not this query is readonly.
QueryOptions
flexIndex(bool $arg)
Sets whether or not this query allowed to use FlexIndex (full text search integration).
QueryOptions
adhoc(bool $arg)
Sets whether or not this query is adhoc.
QueryOptions
namedParameters(array $pairs)
Sets the named parameters for this query.
QueryOptions
positionalParameters(array $args)
Sets the positional parameters for this query.
QueryOptions
raw(string $key, string $value)
Sets any extra query parameters that the SDK does not provide an option for.
QueryOptions
clientContextId(string $arg)
Sets the client context id for this query.
QueryOptions
metrics(bool $arg)
Sets whether or not to return metrics with the query.
QueryOptions
scopeName(string $arg)
Associate scope name with query
QueryOptions
scopeQualifier(string $arg)
Associate scope qualifier (also known as query_context) with the query.
The qualifier must be in form ${bucketName}.${scopeName} or default:${bucketName}.${scopeName}