Options for collection::get().
More...
#include <couchbase/get_options.hxx>
|
struct | built |
| Immutable value object representing consistent options. More...
|
|
Options for collection::get().
- 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
◆ project()
auto project |
( |
std::vector< std::string > | field_paths | ) |
-> get_options&
|
|
inline |
Allows to specify a custom list paths to fetch from the document instead of the whole.
- Note
- that a maximum of 16 individual paths can be projected at a time due to a server limitation. If you need more than that, think about fetching less-generic paths or the full document straight away.
- Parameters
-
field_paths | a list of paths that should be loaded if present. |
- Returns
- this options builder for chaining purposes.
- Since
- 1.0.0
- Committed
- Generally available API and should be preferred in production
◆ with_expiry()
If set to true, the get will fetch the expiry for the document as well and return it as part of the get_result
.
- Parameters
-
return_expiry | true if it should be fetched. |
- Returns
- this 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: