UpsertOptions
in package
Table of Contents
- durabilityLevel() : UpsertOptions
- Sets the durability level to enforce when writing the document.
- encoder() : UpsertOptions
- Associate custom transcoder with the request.
- expiry() : UpsertOptions
- Sets the expiry time for the document.
- preserveExpiry() : UpsertOptions
- Sets whether the original expiration should be preserved (by default Replace operation updates expiration).
- timeout() : UpsertOptions
- Sets the operation timeout in milliseconds.
Methods
durabilityLevel()
Sets the durability level to enforce when writing the document.
public
durabilityLevel(int $arg) : UpsertOptions
Parameters
- $arg : int
-
the durability level to enforce
Return values
UpsertOptions —encoder()
Associate custom transcoder with the request.
public
encoder(callable $arg) : UpsertOptions
Parameters
- $arg : callable
-
encoding function with signature (returns tuple of bytes, flags and datatype):
function encoder($value): [string $bytes, int $flags, int $datatype]
Return values
UpsertOptions —expiry()
Sets the expiry time for the document.
public
expiry(int|DateTimeInterface $arg) : UpsertOptions
Parameters
- $arg : int|DateTimeInterface
-
the relative expiry time in seconds or DateTimeInterface object for absolute point in time
Return values
UpsertOptions —preserveExpiry()
Sets whether the original expiration should be preserved (by default Replace operation updates expiration).
public
preserveExpiry(bool $shouldPreserve) : UpsertOptions
Parameters
- $shouldPreserve : bool
-
if true, the expiration time will not be updated
Return values
UpsertOptions —timeout()
Sets the operation timeout in milliseconds.
public
timeout(int $arg) : UpsertOptions
Parameters
- $arg : int
-
the operation timeout to apply