Range scan
- class couchbase.kv_range_scan.PrefixScan(prefix: str)
A scan of every document whose ID starts with a prefix.
- Parameters:
prefix (str) – The prefix the IDs share.
- class couchbase.kv_range_scan.RangeScan(start: ScanTerm | None = None, end: ScanTerm | None = None)
A scan of every document whose ID falls between two terms.
- Parameters:
- class couchbase.kv_range_scan.SamplingScan(limit: int, seed: int | None = None)
A scan of a random sample of the collection’s documents.
- Parameters:
- class couchbase.kv_range_scan.ScanTerm(term: str, exclusive: bool | None = None)
One end of a
RangeScan.- Parameters:
- Raises:
InvalidArgumentException – If the term is not a str.
- class couchbase.kv_range_scan.ScanType
The kind of scan
scan()runs.Pass one of
RangeScan,PrefixScanorSamplingScan.