class GetOptions (View source)

Methods

timeout(int $arg)

Sets the operation timeout in milliseconds.

withExpiry(bool $arg)

Sets whether to include document expiry with the document content.

project(array $arg)

Sets whether to cause the Get operation to only fetch the fields from the document indicated by the paths provided.

decoder(callable $arg)

Associate custom transcoder with the request.

Details

GetOptions timeout(int $arg)

Sets the operation timeout in milliseconds.

Parameters

int $arg

the operation timeout to apply

Return Value

GetOptions

GetOptions withExpiry(bool $arg)

Sets whether to include document expiry with the document content.

When used this option will transparently transform the Get operation into a subdocument operation performing a full document fetch as well as the expiry.

Parameters

bool $arg

whether or not to include document expiry

Return Value

GetOptions

GetOptions project(array $arg)

Sets whether to cause the Get operation to only fetch the fields from the document indicated by the paths provided.

When used this option will transparently transform the Get operation into a subdocument operation fetching only the required fields.

Parameters

array $arg

the array of field names

Return Value

GetOptions

GetOptions decoder(callable $arg)

Associate custom transcoder with the request.

Parameters

callable $arg

decoding function with signature (returns decoded value):

function decoder(string $bytes, int $flags, int $datatype): mixed

Return Value

GetOptions