A range scan performs a scan on a range of keys.
More...
#include <couchbase/scan_type.hxx>
A range scan performs a scan on a range of keys.
- Since
- 1.0.0
- Committed
- Generally available API and should be preferred in production
◆ range_scan() [1/2]
Creates an instance of a range scan type with no bounds.
- Since
- 1.0.0
- Committed
- Generally available API and should be preferred in production
◆ range_scan() [2/2]
Creates an instance of a range scan type.
- Parameters
-
from | the scan term representing the lower bound of the range, optional. |
to | the scan term representing the upper bound of the range, optional. |
- Since
- 1.0.0
- Committed
- Generally available API and should be preferred in production
◆ build()
auto build |
( |
| ) |
const -> built |
|
inlinenodiscardoverridevirtual |
Returns the range scan type as an immutable value.
- Returns
- scan type as an immutable value.
- Since
- 1.0.0
- Internal
- Internal interface
Implements scan_type.
◆ from()
Specifies the lower bound of the range.
- Parameters
-
from | scan term representing the lower bound. |
- Returns
- the range scan object for chaining purposes.
- Since
- 1.0.0
- Committed
- Generally available API and should be preferred in production
◆ to()
Specifies the upper bound of the range.
- Parameters
-
to | scan term representing the upper bound. |
- Returns
- the range scan object for chaining purposes.
- Since
- 1.0.0
- Committed
- Generally available API and should be preferred in production
The documentation for this struct was generated from the following file: