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

ReplaceOptions

class ReplaceOptions (View source)

Methods

ReplaceOptions
timeout(int $arg)

Sets the operation timeout in milliseconds.

ReplaceOptions
expiry(mixed $arg)

Sets the expiry time for the document.

ReplaceOptions
preserveExpiry(bool $shouldPreserve)

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

ReplaceOptions
cas(string $arg)

Sets the cas value for the operation.

ReplaceOptions
durabilityLevel(int $arg)

Sets the durability level to enforce when writing the document.

ReplaceOptions
encoder(callable $arg)

Associate custom transcoder with the request.

Details

at line 3401
ReplaceOptions timeout(int $arg)

Sets the operation timeout in milliseconds.

Parameters

int $arg

the operation timeout to apply

Return Value

ReplaceOptions

at line 3409
ReplaceOptions 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

ReplaceOptions

at line 3417
ReplaceOptions 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

ReplaceOptions

at line 3425
ReplaceOptions cas(string $arg)

Sets the cas value for the operation.

Parameters

string $arg

the cas value

Return Value

ReplaceOptions

at line 3433
ReplaceOptions durabilityLevel(int $arg)

Sets the durability level to enforce when writing the document.

Parameters

int $arg

the durability level to enforce

Return Value

ReplaceOptions

at line 3442
ReplaceOptions 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

ReplaceOptions