Class ScanTerm

A single ScanTermidentifying either the point to scan from or to scan to when performing a Range Scan.

Inheritance

object

ScanTerm

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Couchbase.KeyValue.RangeScan

Assembly: Couchbase.NetClient.dll

Syntax

[InterfaceStability(Level.Volatile)]
public sealed class ScanTerm

Properties

Id

The term to scan.

Declaration

public string Id { get; }

Property Value

Type	Description
string

IsExclusive

Controls whether the scan is inclusive or exclusive.

Declaration

public bool IsExclusive { get; }

Property Value

Type	Description
bool

Methods

Exclusive(string)

Creates an exclusive scan for a term.

Declaration

public static ScanTerm Exclusive(string id)

Parameters

Type	Name	Description
string	id	The term to scan.

Returns

Type	Description
ScanTerm	A ScanTerm instance for an exclusive scan.

Inclusive(string)

Creates an Inclusive scan for a term.

Declaration

public static ScanTerm Inclusive(string id)

Parameters

Type	Name	Description
string	id	The term to scan.

Returns

Type	Description
ScanTerm	A ScanTerm instance for an inclusive scan.