Interface IScanType
A marker interface for scan implementations.
Namespace: Couchbase.KeyValue.RangeScan
Assembly: Couchbase.NetClient.dll
Syntax
public interface IScanTypeMethods
| Edit this page View SourcePrefixScan(string)
Creates a new KV range scan, scanning all document IDs starting with the given Prefix.
Declaration
PrefixScan? PrefixScan(string prefix)Parameters
| Type | Name | Description |
|---|---|---|
| string | prefix | The Prefix ScanTerm to start scanning from. |
Returns
| Type | Description |
|---|---|
| PrefixScan | A newly created PrefixScan(string) to be passed into the Collection API. |
RangeScan(ScanTerm, ScanTerm)
Creates a new KV range scan, scanning between two ScanTerm ScanTerms.
Declaration
RangeScan? RangeScan(ScanTerm from, ScanTerm to)Parameters
| Type | Name | Description |
|---|---|---|
| ScanTerm | from | From the ScanTerm to start scanning from. |
| ScanTerm | to | To the ScanTerm to scan to. |
Returns
| Type | Description |
|---|---|
| RangeScan | A newly created RangeScan(ScanTerm, ScanTerm) to be passed into the Collection API. |
SamplingScan(ulong)
Creates a new KV sampling scan, which randomly samples documents up until the configured limit with a default seed.
Declaration
SamplingScan? SamplingScan(ulong limit)Parameters
| Type | Name | Description |
|---|---|---|
| ulong | limit | limit the number of documents to limit sampling to. |
Returns
| Type | Description |
|---|---|
| SamplingScan | A newly created SamplingScan(ulong) to be passed into the Collection API. |
SamplingScan(ulong, ulong)
Creates a new KV sampling scan, which randomly samples documents up until the configured limit with a custom seed.
Declaration
SamplingScan? SamplingScan(ulong limit, ulong seed)Parameters
| Type | Name | Description |
|---|---|---|
| ulong | limit | |
| ulong | seed | The custom seed used for sampling. |
Returns
| Type | Description |
|---|---|
| SamplingScan |