Options for collection::scan().
More...
#include <couchbase/scan_options.hxx>
|
struct | built |
| Immutable value object representing consistent options. More...
|
|
Options for collection::scan().
- Since
- 1.0.0
- Committed
- Generally available API and should be preferred in production
◆ batch_byte_limit()
auto batch_byte_limit |
( |
std::uint32_t | batch_byte_limit | ) |
-> scan_options&
|
|
inline |
Allows to limit the maximum amount of bytes that are sent from the server in each partition batch.
Defaults to 15,000.
- Parameters
-
batch_byte_limit | the byte limit |
- Returns
- the options builder for chaining purposes.
- Since
- 1.0.0
- Committed
- Generally available API and should be preferred in production
◆ batch_item_limit()
auto batch_item_limit |
( |
std::uint32_t | batch_item_limit | ) |
-> scan_options&
|
|
inline |
Allows to limit the maximum number of scan items that are sent from the server in each partition batch.
Defaults to 50.
- Parameters
-
batch_item_limit | the item limit |
- Returns
- the options builder for chaining purposes.
- Since
- 1.0.0
- Committed
- Generally available API and should be preferred in production
◆ build()
auto build |
( |
| ) |
const -> built
|
|
inlinenodiscard |
Validates options and returns them as an immutable value.
- Returns
- consistent options as an immutable value.
- Exceptions
-
- Since
- 1.0.0
- Internal
- Internal interface
◆ concurrency()
auto concurrency |
( |
std::uint16_t | concurrency | ) |
-> scan_options&
|
|
inline |
Specifies the maximum number of partitions that can be scanned concurrently.
Defaults to 1.
- Parameters
-
concurrency | the maximum number of concurrent partition scans |
- Returns
- the options builder for chaining purposes.
- Since
- 1.0.0
- Committed
- Generally available API and should be preferred in production
◆ consistent_with()
Sets the mutation_token
s this scan should be consistent with.
These mutation tokens are returned from mutations (i.e. as part of a mutation_result
) and if you want your scan to include those you need to pass the mutation tokens into a mutation_state
.
- Parameters
-
state | the mutation state containing the mutation tokens. |
- Returns
- the options builder for chaining purposes.
- Since
- 1.0.0
- Committed
- Generally available API and should be preferred in production
◆ ids_only()
Specifies whether only document IDs should be included in the results.
Defaults to false.
- Parameters
-
ids_only | if set to true the content will not be included in the results |
- Returns
- the options builder 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: