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