ScanOptions
in package
Table of Contents
- $batchByteLimit : int|null
- $batchItemLimit : int|null
- $concurrency : int|null
- $consistentWith : MutationState|null
- $idsOnly : bool|null
- $timeoutMilliseconds : int|null
- $transcoder : Transcoder
- __construct() : mixed
- batchByteLimit() : ScanOptions
- Sets the limit applied to the number of bytes returned from the server for each partition batch
- batchItemLimit() : ScanOptions
- Sets the limit applied to the number of items returned from the server for each partition batch
- build() : ScanOptions
- Static helper to keep code more readable
- concurrency() : ScanOptions
- Specifies the number of vBuckets which the client should scan in parallel
- consistentWith() : ScanOptions
- Sets the mutation state to achieve consistency with for read your own writes (RYOW).
- getTranscoder() : Transcoder
- Returns associated transcoder.
- idsOnly() : ScanOptions
- Sets if the scan should only return document ids.
- timeout() : ScanOptions
- Sets the operation timeout in milliseconds.
- transcoder() : ScanOptions
- Associate custom transcoder with the request.
Properties
$batchByteLimit
private
int|null
$batchByteLimit
= null
$batchItemLimit
private
int|null
$batchItemLimit
= null
$concurrency
private
int|null
$concurrency
= null
$consistentWith
private
MutationState|null
$consistentWith
= null
$idsOnly
private
bool|null
$idsOnly
= null
$timeoutMilliseconds
private
int|null
$timeoutMilliseconds
= null
$transcoder
private
Transcoder
$transcoder
Methods
__construct()
public
__construct() : mixed
Tags
Return values
mixed —batchByteLimit()
Sets the limit applied to the number of bytes returned from the server for each partition batch
public
batchByteLimit(int $batchByteLimit) : ScanOptions
Parameters
- $batchByteLimit : int
Tags
Return values
ScanOptions —batchItemLimit()
Sets the limit applied to the number of items returned from the server for each partition batch
public
batchItemLimit(int $batchItemLimit) : ScanOptions
Parameters
- $batchItemLimit : int
Tags
Return values
ScanOptions —build()
Static helper to keep code more readable
public
static build() : ScanOptions
Tags
Return values
ScanOptions —concurrency()
Specifies the number of vBuckets which the client should scan in parallel
public
concurrency(int $concurrency) : ScanOptions
Parameters
- $concurrency : int
Tags
Return values
ScanOptions —consistentWith()
Sets the mutation state to achieve consistency with for read your own writes (RYOW).
public
consistentWith(MutationState $state) : ScanOptions
Parameters
- $state : MutationState
-
the mutation state to achieve consistency with
Tags
Return values
ScanOptions —getTranscoder()
Returns associated transcoder.
public
static getTranscoder(ScanOptions|null $options) : Transcoder
Parameters
- $options : ScanOptions|null
Tags
Return values
Transcoder —idsOnly()
Sets if the scan should only return document ids.
public
idsOnly(bool $idsOnly) : ScanOptions
Parameters
- $idsOnly : bool
Tags
Return values
ScanOptions —timeout()
Sets the operation timeout in milliseconds.
public
timeout(int $milliseconds) : ScanOptions
Parameters
- $milliseconds : int
-
the operation timeout to apply
Tags
Return values
ScanOptions —transcoder()
Associate custom transcoder with the request.
public
transcoder(Transcoder $transcoder) : ScanOptions
Parameters
- $transcoder : Transcoder