TransactionQueryOptions
in package
Table of Contents
- $adHoc : bool|null
- $clientContextId : string|null
- $consistentWith : MutationState|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
- $profile : int|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() : TransactionQueryOptions
- Sets whether this query is adhoc.
- build() : TransactionQueryOptions
- Static helper to keep code more readable
- clientContextId() : TransactionQueryOptions
- Sets the client context id for this query.
- consistentWith() : TransactionQueryOptions
- Sets the mutation state to achieve consistency with for read your own writes (RYOW).
- export() : array<string|int, mixed>
- getTranscoder() : Transcoder
- Returns associated transcoder.
- maxParallelism() : TransactionQueryOptions
- Sets the maximum number of index partitions, for computing aggregation in parallel.
- metrics() : TransactionQueryOptions
- Sets whether to return metrics with the query.
- namedParameters() : TransactionQueryOptions
- Sets the named parameters for this query.
- pipelineBatch() : TransactionQueryOptions
- Sets the number of items execution operators can batch for fetch from the KV service.
- pipelineCap() : TransactionQueryOptions
- Sets the maximum number of items each execution operator can buffer between various operators.
- positionalParameters() : TransactionQueryOptions
- Sets the positional parameters for this query.
- profile() : TransactionQueryOptions
- Sets the query profile mode to use.
- raw() : TransactionQueryOptions
- Sets any extra query parameters that the SDK does not provide an option for.
- readonly() : TransactionQueryOptions
- Sets whether this query is readonly.
- scanCap() : TransactionQueryOptions
- Sets the maximum buffered channel size between the indexer client and the query service for index scans.
- scanConsistency() : TransactionQueryOptions
- Sets the scan consistency.
- scanWait() : TransactionQueryOptions
- This is an advanced option, see the query service reference for more information on the proper use and tuning of this option.
- scopeName() : TransactionQueryOptions
- Associate scope name with query
- scopeQualifier() : TransactionQueryOptions
- Associate scope qualifier (also known as `query_context`) with the query.
- timeout() : TransactionQueryOptions
- Sets the operation timeout in milliseconds.
- transcoder() : TransactionQueryOptions
- Associate custom transcoder with the request.
Properties
$adHoc
private
bool|null
$adHoc
= null
$clientContextId
private
string|null
$clientContextId
= null
$consistentWith
private
MutationState|null
$consistentWith
= null
$maxParallelism
private
int|null
$maxParallelism
= null
$metrics
private
bool|null
$metrics
= null
$namedParameters
private
array<string|int, mixed>|null
$namedParameters
= null
$pipelineBatch
private
int|null
$pipelineBatch
= null
$pipelineCap
private
int|null
$pipelineCap
= null
$positionalParameters
private
array<string|int, mixed>|null
$positionalParameters
= null
$profile
private
int|null
$profile
= null
$raw
private
array<string|int, mixed>|null
$raw
= null
$readonly
private
bool|null
$readonly
= null
$scanCap
private
int|null
$scanCap
= null
$scanConsistency
private
string|null
$scanConsistency
= null
$scanWaitMilliseconds
private
int|null
$scanWaitMilliseconds
= null
$scopeName
private
string|null
$scopeName
= null
$scopeQualifier
private
string|null
$scopeQualifier
= null
$timeoutMilliseconds
private
int|null
$timeoutMilliseconds
= null
$transcoder
private
Transcoder
$transcoder
Methods
__construct()
public
__construct() : mixed
Tags
Return values
mixed —adhoc()
Sets whether this query is adhoc.
public
adhoc(bool $enabled) : TransactionQueryOptions
Parameters
- $enabled : bool
-
whether the query is adhoc
Tags
Return values
TransactionQueryOptions —build()
Static helper to keep code more readable
public
static build() : TransactionQueryOptions
Tags
Return values
TransactionQueryOptions —clientContextId()
Sets the client context id for this query.
public
clientContextId(string $id) : TransactionQueryOptions
Parameters
- $id : string
-
the client context id
Tags
Return values
TransactionQueryOptions —consistentWith()
Sets the mutation state to achieve consistency with for read your own writes (RYOW).
public
consistentWith(MutationState $state) : TransactionQueryOptions
Parameters
- $state : MutationState
-
the mutation state to achieve consistency with
Tags
Return values
TransactionQueryOptions —export()
public
static export(TransactionQueryOptions|null $options[, string|null $scopeName = null ][, string|null $bucketName = null ]) : array<string|int, mixed>
Parameters
- $options : TransactionQueryOptions|null
- $scopeName : string|null = null
- $bucketName : string|null = null
Return values
array<string|int, mixed> —getTranscoder()
Returns associated transcoder.
public
static getTranscoder(TransactionQueryOptions|null $options) : Transcoder
Parameters
- $options : TransactionQueryOptions|null
Tags
Return values
Transcoder —maxParallelism()
Sets the maximum number of index partitions, for computing aggregation in parallel.
public
maxParallelism(int $max) : TransactionQueryOptions
Parameters
- $max : int
-
the number of index partitions
Return values
TransactionQueryOptions —metrics()
Sets whether to return metrics with the query.
public
metrics(bool $enabled) : TransactionQueryOptions
Parameters
- $enabled : bool
-
whether to return metrics
Tags
Return values
TransactionQueryOptions —namedParameters()
Sets the named parameters for this query.
public
namedParameters(array<string|int, mixed> $pairs) : TransactionQueryOptions
Parameters
- $pairs : array<string|int, mixed>
-
the associative array of parameters
Tags
Return values
TransactionQueryOptions —pipelineBatch()
Sets the number of items execution operators can batch for fetch from the KV service.
public
pipelineBatch(int $batchSize) : TransactionQueryOptions
Parameters
- $batchSize : int
-
the pipeline batch size
Tags
Return values
TransactionQueryOptions —pipelineCap()
Sets the maximum number of items each execution operator can buffer between various operators.
public
pipelineCap(int $cap) : TransactionQueryOptions
Parameters
- $cap : int
-
the maximum number of items each execution operation can buffer
Tags
Return values
TransactionQueryOptions —positionalParameters()
Sets the positional parameters for this query.
public
positionalParameters(array<string|int, mixed> $params) : TransactionQueryOptions
Parameters
- $params : array<string|int, mixed>
-
the array of parameters
Tags
Return values
TransactionQueryOptions —profile()
Sets the query profile mode to use.
public
profile(int $mode) : TransactionQueryOptions
Parameters
- $mode : int
-
the query profile mode
Tags
Return values
TransactionQueryOptions —raw()
Sets any extra query parameters that the SDK does not provide an option for.
public
raw(string $key, string $value) : TransactionQueryOptions
Parameters
- $key : string
-
the name of the parameter
- $value : string
-
the value of the parameter
Tags
Return values
TransactionQueryOptions —readonly()
Sets whether this query is readonly.
public
readonly(bool $readonly) : TransactionQueryOptions
Parameters
- $readonly : bool
-
whether the query is readonly
Tags
Return values
TransactionQueryOptions —scanCap()
Sets the maximum buffered channel size between the indexer client and the query service for index scans.
public
scanCap(int $cap) : TransactionQueryOptions
Parameters
- $cap : int
-
the maximum buffered channel size
Tags
Return values
TransactionQueryOptions —scanConsistency()
Sets the scan consistency.
public
scanConsistency(string $consistencyLevel) : TransactionQueryOptions
Parameters
- $consistencyLevel : string
-
the scan consistency level.
Tags
Return values
TransactionQueryOptions —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) : TransactionQueryOptions
Parameters
- $milliseconds : int
Tags
Return values
TransactionQueryOptions —scopeName()
Associate scope name with query
public
scopeName(string $name) : TransactionQueryOptions
Parameters
- $name : string
-
the name of the scope
Tags
Return values
TransactionQueryOptions —scopeQualifier()
Associate scope qualifier (also known as `query_context`) with the query.
public
scopeQualifier(string $qualifier) : TransactionQueryOptions
The qualifier must be in form ${bucketName}.${scopeName} or default:${bucketName}.${scopeName}
Parameters
- $qualifier : string
-
the scope qualifier
Tags
Return values
TransactionQueryOptions —timeout()
Sets the operation timeout in milliseconds.
public
timeout(int $milliseconds) : TransactionQueryOptions
Parameters
- $milliseconds : int
-
the operation timeout to apply
Tags
Return values
TransactionQueryOptions —transcoder()
Associate custom transcoder with the request.
public
transcoder(Transcoder $transcoder) : TransactionQueryOptions
Parameters
- $transcoder : Transcoder