LookupInAllReplicasOptions
in package
Table of Contents
- $readPreference : string
- $timeoutMilliseconds : int|null
- $transcoder : Transcoder
- $withExpiry : bool|null
- __construct() : mixed
- build() : LookupInAllReplicasOptions
- Static helper to keep code more readable
- getTranscoder() : Transcoder
- Returns associated transcoder.
- readPreference() : LookupInAllReplicasOptions
- Choose how the replica nodes will be selected. By default, it has no preference and will select any available replica, but it is possible to prioritize or restrict to only nodes in local server group
- timeout() : LookupInAllReplicasOptions
- Sets the operation timeout in milliseconds.
- transcoder() : LookupInAllReplicasOptions
- Associate custom transcoder with the request.
- withExpiry() : LookupInAllReplicasOptions
- Sets whether to include document expiry with the document content.
Properties
$readPreference
private
string
$readPreference
$timeoutMilliseconds
private
int|null
$timeoutMilliseconds
= null
$transcoder
private
Transcoder
$transcoder
$withExpiry
private
bool|null
$withExpiry
= null
Methods
__construct()
public
__construct() : mixed
Tags
Return values
mixed —build()
Static helper to keep code more readable
public
static build() : LookupInAllReplicasOptions
Tags
Return values
LookupInAllReplicasOptions —getTranscoder()
Returns associated transcoder.
public
static getTranscoder(LookupInAllReplicasOptions|null $options) : Transcoder
Parameters
- $options : LookupInAllReplicasOptions|null
Tags
Return values
Transcoder —readPreference()
Choose how the replica nodes will be selected. By default, it has no preference and will select any available replica, but it is possible to prioritize or restrict to only nodes in local server group
public
readPreference(string $readPreference) : LookupInAllReplicasOptions
Parameters
- $readPreference : string
Tags
Return values
LookupInAllReplicasOptions —timeout()
Sets the operation timeout in milliseconds.
public
timeout(int $milliseconds) : LookupInAllReplicasOptions
Parameters
- $milliseconds : int
-
the operation timeout to apply
Tags
Return values
LookupInAllReplicasOptions —transcoder()
Associate custom transcoder with the request.
public
transcoder(Transcoder $transcoder) : LookupInAllReplicasOptions
Parameters
- $transcoder : Transcoder
Tags
Return values
LookupInAllReplicasOptions —withExpiry()
Sets whether to include document expiry with the document content.
public
withExpiry(bool $fetchExpiry) : LookupInAllReplicasOptions
When used this option will add one extra subdocument path into the LookupIn operation. This can cause the set of subdocument paths to exceed the maximum number (16) of paths allowed in a subdocument operation.
Parameters
- $fetchExpiry : bool
-
whether to include document expiry