Documentation

GetOptions

Table of Contents

timeout() Sets the operation timeout in milliseconds. GetOptions
withExpiry() Sets whether to include document expiry with the document content. GetOptions
project() Sets whether to cause the Get operation to only fetch the fields from the document indicated by the paths provided. GetOptions

Methods

timeout()

Sets the operation timeout in milliseconds.

public timeout( $arg : int ) : GetOptions
Parameters
$arg : int

the operation timeout to apply

Return values
GetOptions

withExpiry()

Sets whether to include document expiry with the document content.

public withExpiry( $arg : bool ) : GetOptions

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
$arg : bool

whether or not to include document expiry

Return values
GetOptions

project()

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

public project( $arg : array ) : GetOptions

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

Parameters
$arg : array

the array of field names

Return values
GetOptions

Search results