ExistsResult
extends Result
in package
Base interface for all results generated by KV operations.
Table of Contents
- $cas : string
- $deleted : bool
- $error : CouchbaseException|null
- $exists : bool
- $expiry : int
- $flags : int
- $id : string
- $sequenceNumber : string
- cas() : string
- Returns the CAS value for the document
- deleted() : bool
- Returns true if the document had been just deleted.
- error() : CouchbaseException|null
- Returns the error (populated for multi-operations)
- exists() : bool
- Returns whether the document exists
- expiryTime() : DateTimeInterface|null
- Returns the document expiration time or null if the document does not expire.
- flags() : int
- id() : string
- Returns the ID of the document
- sequenceNumber() : string
Properties
$cas
private
string
$cas
$deleted
private
bool
$deleted
$error
private
CouchbaseException|null
$error
= null
$exists
private
bool
$exists
$expiry
private
int
$expiry
$flags
private
int
$flags
$id
private
string
$id
$sequenceNumber
private
string
$sequenceNumber
Methods
cas()
Returns the CAS value for the document
public
cas() : string
Return values
string —deleted()
Returns true if the document had been just deleted.
public
deleted() : bool
Tags
Return values
bool —error()
Returns the error (populated for multi-operations)
public
error() : CouchbaseException|null
Tags
Return values
CouchbaseException|null —exists()
Returns whether the document exists
public
exists() : bool
Tags
Return values
bool —expiryTime()
Returns the document expiration time or null if the document does not expire.
public
expiryTime() : DateTimeInterface|null
Note, that this function will return expiry only when GetOptions had withExpiry set to true.
Tags
Return values
DateTimeInterface|null —flags()
public
flags() : int
Return values
int —id()
Returns the ID of the document
public
id() : string
Tags
Return values
string —sequenceNumber()
public
sequenceNumber() : string