Documentation

QueryOptions
in package

Table of Contents

$adHoc  : bool|null
$clientContextId  : string|null
$consistentWith  : MutationState|null
$flexIndex  : bool|null
$maxParallelism  : int|null
$metrics  : bool|null
$namedParameters  : array<string|int, mixed>|null
$pipelineBatch  : int|null
$pipelineCap  : int|null
$positionalParameters  : array<string|int, mixed>|null
$preserveExpiry  : bool|null
$profile  : string|null
$raw  : array<string|int, mixed>|null
$readonly  : bool|null
$scanCap  : int|null
$scanConsistency  : string|null
$scanWaitMilliseconds  : int|null
$scopeName  : string|null
$scopeQualifier  : string|null
$timeoutMilliseconds  : int|null
$transcoder  : Transcoder
__construct()  : mixed
adhoc()  : QueryOptions
Sets whether this query is adhoc.
build()  : QueryOptions
Static helper to keep code more readable
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).
export()  : array<string|int, mixed>
flexIndex()  : QueryOptions
Sets whether this query allowed to use FlexIndex (full text search integration).
getTranscoder()  : Transcoder
Returns associated transcoder.
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.
preserveExpiry()  : QueryOptions
Sets whether to tell the query engine to preserve expiration values set on any documents modified by 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 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.
scanWait()  : QueryOptions
This is an advanced option, see the query service reference for more information on the proper use and tuning of this option.
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.
transcoder()  : QueryOptions
Associate custom transcoder with the request.

Properties

$clientContextId

private string|null $clientContextId = null

$namedParameters

private array<string|int, mixed>|null $namedParameters = null

$positionalParameters

private array<string|int, mixed>|null $positionalParameters = null

$preserveExpiry

private bool|null $preserveExpiry = null

$scanConsistency

private string|null $scanConsistency = null

$scanWaitMilliseconds

private int|null $scanWaitMilliseconds = null

$scopeQualifier

private string|null $scopeQualifier = null

$timeoutMilliseconds

private int|null $timeoutMilliseconds = null

Methods

__construct()

public __construct() : mixed
Tags
since
4.0.0
Return values
mixed

adhoc()

Sets whether this query is adhoc.

public adhoc(bool $enabled) : QueryOptions
Parameters
$enabled : bool

whether the query is adhoc

Tags
since
4.0.0
Return values
QueryOptions

clientContextId()

Sets the client context id for this query.

public clientContextId(string $id) : QueryOptions
Parameters
$id : string

the client context id

Tags
since
4.0.0
Return values
QueryOptions

export()

public static export(QueryOptions|null $options[, string $scopeName = null ][, string $bucketName = null ]) : array<string|int, mixed>
Parameters
$options : QueryOptions|null
$scopeName : string = null
$bucketName : string = null
Return values
array<string|int, mixed>

flexIndex()

Sets whether this query allowed to use FlexIndex (full text search integration).

public flexIndex(bool $enabled) : QueryOptions
Parameters
$enabled : bool

whether the FlexIndex allowed

Tags
since
4.0.0
Return values
QueryOptions

maxParallelism()

Sets the maximum number of index partitions, for computing aggregation in parallel.

public maxParallelism(int $max) : QueryOptions
Parameters
$max : int

the number of index partitions

Return values
QueryOptions

metrics()

Sets whether or not to return metrics with the query.

public metrics(bool $enabled) : QueryOptions
Parameters
$enabled : bool

whether to return metrics

Tags
since
4.0.0
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

Tags
since
4.0.0
Return values
QueryOptions

pipelineBatch()

Sets the number of items execution operators can batch for fetch from the KV service.

public pipelineBatch(int $batchSize) : QueryOptions
Parameters
$batchSize : int

the pipeline batch size

Tags
since
4.0.0
Return values
QueryOptions

pipelineCap()

Sets the maximum number of items each execution operator can buffer between various operators.

public pipelineCap(int $cap) : QueryOptions
Parameters
$cap : int

the maximum number of items each execution operation can buffer

Tags
since
4.0.0
Return values
QueryOptions

positionalParameters()

Sets the positional parameters for this query.

public positionalParameters(array<string|int, mixed> $params) : QueryOptions
Parameters
$params : array<string|int, mixed>

the array of parameters

Tags
since
4.0.0
Return values
QueryOptions

preserveExpiry()

Sets whether to tell the query engine to preserve expiration values set on any documents modified by this query.

public preserveExpiry(bool $preserve) : QueryOptions
Parameters
$preserve : bool

whether to preserve expiration values.

Tags
since
4.0.0
Return values
QueryOptions

profile()

Sets the query profile mode to use.

public profile(string|int $mode) : QueryOptions
Parameters
$mode : string|int

the query profile mode

Tags
since
4.0.0
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

Tags
since
4.0.0
Return values
QueryOptions

readonly()

Sets whether this query is readonly.

public readonly(bool $readonly) : QueryOptions
Parameters
$readonly : bool

whether the query is readonly

Tags
since
4.0.0
Return values
QueryOptions

scanCap()

Sets the maximum buffered channel size between the indexer client and the query service for index scans.

public scanCap(int $cap) : QueryOptions
Parameters
$cap : int

the maximum buffered channel size

Tags
since
4.0.0
Return values
QueryOptions

scanWait()

This is an advanced option, see the query service reference for more information on the proper use and tuning of this option.

public scanWait(int $milliseconds) : QueryOptions
Parameters
$milliseconds : int
Tags
since
4.0.0
Return values
QueryOptions

scopeName()

Associate scope name with query

public scopeName(string $name) : QueryOptions
Parameters
$name : string

the name of the scope

Tags
deprecated
since
4.0.0
Return values
QueryOptions

scopeQualifier()

Associate scope qualifier (also known as `query_context`) with the query.

public scopeQualifier(string $qualifier) : QueryOptions

The qualifier must be in form ${bucketName}.${scopeName} or default:${bucketName}.${scopeName}

Parameters
$qualifier : string

the scope qualifier

Tags
deprecated
since
4.0.0
Return values
QueryOptions

timeout()

Sets the operation timeout in milliseconds.

public timeout(int $milliseconds) : QueryOptions
Parameters
$milliseconds : int

the operation timeout to apply

Tags
since
4.0.0
Return values
QueryOptions

        

Search results