Interface IScanResult

An individual result from a KV Range Scan

Namespace: Couchbase.KeyValue.RangeScan
Assembly: Couchbase.NetClient.dll
Syntax
public interface IScanResult

Properties

View Source

Cas

Compare and Set value for optimistic locking of a document.

Declaration
ulong Cas { get; }
Property Value
Type Description
ulong
View Source

ExpiryTime

The time in which the document will expire and be evicted from the cluster.

Declaration
DateTime? ExpiryTime { get; }
Property Value
Type Description
DateTime?
View Source

Id

The identifier for the document.

Declaration
string Id { get; }
Property Value
Type Description
string
View Source

IdOnly

Indicates if the scan was requested with IDs only.

Declaration
bool IdOnly { get; }
Property Value
Type Description
bool

Methods

View Source

ContentAsBytes()

Declaration
byte[] ContentAsBytes()
Returns
Type Description
byte[]
View Source

ContentAsString()

Declaration
string ContentAsString()
Returns
Type Description
string
View Source

ContentAs<T>()

Returns the content of the scan result if IdsOnly(bool) is false.

Declaration
T ContentAs<T>()
Returns
Type Description
T
Type Parameters
Name Description
T

The underlying document type; POCO or dynamic/object for example.