1. class
  2. Couchbase
  3. \
  4. UpsertOptions

UpsertOptions

class UpsertOptions (View source)

Methods

UpsertOptions
timeout(int $arg)

Sets the operation timeout in milliseconds.

UpsertOptions
expiry(mixed $arg)

Sets the expiry time for the document.

UpsertOptions
preserveExpiry(bool $shouldPreserve)

Sets whether the original expiration should be preserved (by default Replace operation updates expiration).

UpsertOptions
durabilityLevel(int $arg)

Sets the durability level to enforce when writing the document.

UpsertOptions
encoder(callable $arg)

Associate custom transcoder with the request.

Details

at line 3357
UpsertOptions timeout(int $arg)

Sets the operation timeout in milliseconds.

Parameters

int $arg

the operation timeout to apply

Return Value

UpsertOptions

at line 3365
UpsertOptions 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

UpsertOptions

at line 3373
UpsertOptions preserveExpiry(bool $shouldPreserve)

Sets whether the original expiration should be preserved (by default Replace operation updates expiration).

Parameters

bool $shouldPreserve

if true, the expiration time will not be updated

Return Value

UpsertOptions

at line 3381
UpsertOptions durabilityLevel(int $arg)

Sets the durability level to enforce when writing the document.

Parameters

int $arg

the durability level to enforce

Return Value

UpsertOptions

at line 3390
UpsertOptions encoder(callable $arg)

Associate custom transcoder with the request.

Parameters

callable $arg

encoding function with signature (returns tuple of bytes, flags and datatype):

function encoder($value): [string $bytes, int $flags, int $datatype]

Return Value

UpsertOptions