MutateInOptions
in package
Table of Contents
- cas() : MutateInOptions
- Sets the cas value to use when performing this operation.
- durabilityLevel() : MutateInOptions
- Sets the durability level to enforce when writing the document.
- expiry() : MutateInOptions
- Sets the expiry time for the document.
- preserveExpiry() : MutateInOptions
- Sets whether the original expiration should be preserved (by default Replace operation updates expiration).
- storeSemantics() : MutateInOptions
- Sets the document level action to use when performing the operation.
- timeout() : MutateInOptions
- Sets the operation timeout in milliseconds.
Methods
cas()
Sets the cas value to use when performing this operation.
public
cas(string $arg) : MutateInOptions
Parameters
- $arg : string
-
the cas value to use
Return values
MutateInOptions —durabilityLevel()
Sets the durability level to enforce when writing the document.
public
durabilityLevel(int $arg) : MutateInOptions
Parameters
- $arg : int
-
the durability level to enforce
Return values
MutateInOptions —expiry()
Sets the expiry time for the document.
public
expiry(int|DateTimeInterface $arg) : MutateInOptions
Parameters
- $arg : int|DateTimeInterface
-
the relative expiry time in seconds or DateTimeInterface object for absolute point in time
Return values
MutateInOptions —preserveExpiry()
Sets whether the original expiration should be preserved (by default Replace operation updates expiration).
public
preserveExpiry(bool $shouldPreserve) : MutateInOptions
Parameters
- $shouldPreserve : bool
-
if true, the expiration time will not be updated
Return values
MutateInOptions —storeSemantics()
Sets the document level action to use when performing the operation.
public
storeSemantics(int $arg) : MutateInOptions
Parameters
- $arg : int
-
the store semantic to use
Return values
MutateInOptions —timeout()
Sets the operation timeout in milliseconds.
public
timeout(int $arg) : MutateInOptions
Parameters
- $arg : int
-
the operation timeout to apply