Documentation

IncrementOptions

Table of Contents

delta()  : IncrementOptions
Sets the value to increment the counter by.
durabilityLevel()  : IncrementOptions
Sets the durability level to enforce when writing the document.
expiry()  : IncrementOptions
Sets the expiry time for the document.
initial()  : IncrementOptions
Sets the value to initialize the counter to if the document does not exist.
timeout()  : IncrementOptions
Sets the operation timeout in milliseconds.

Methods

durabilityLevel()

Sets the durability level to enforce when writing the document.

public durabilityLevel(int $arg) : IncrementOptions
Parameters
$arg : int

the durability level to enforce

Return values
IncrementOptions

expiry()

Sets the expiry time for the document.

public expiry(int|DateTimeInterface $arg) : IncrementOptions
Parameters
$arg : int|DateTimeInterface

the relative expiry time in seconds or DateTimeInterface object for absolute point in time

Return values
IncrementOptions

initial()

Sets the value to initialize the counter to if the document does not exist.

public initial(int $arg) : IncrementOptions
Parameters
$arg : int

the initial value to use if counter does not exist

Return values
IncrementOptions

Search results