class IncrementOptions (View source)

Methods

timeout(int $arg)

Sets the operation timeout in milliseconds.

expiry(mixed $arg)

Sets the expiry time for the document.

durabilityLevel(int $arg)

Sets the durability level to enforce when writing the document.

delta(int $arg)

Sets the value to increment the counter by.

initial(int $arg)

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

Details

IncrementOptions timeout(int $arg)

Sets the operation timeout in milliseconds.

Parameters

int $arg

the operation timeout to apply

Return Value

IncrementOptions

IncrementOptions expiry(mixed $arg)

Sets the expiry time for the document.

Parameters

mixed $arg

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

Return Value

IncrementOptions

IncrementOptions durabilityLevel(int $arg)

Sets the durability level to enforce when writing the document.

Parameters

int $arg

the durability level to enforce

Return Value

IncrementOptions

IncrementOptions delta(int $arg)

Sets the value to increment the counter by.

Parameters

int $arg

the value to increment by

Return Value

IncrementOptions

IncrementOptions initial(int $arg)

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

Parameters

int $arg

the initial value to use if counter does not exist

Return Value

IncrementOptions