Options for collection::remove().
More...
#include <couchbase/remove_options.hxx>
|
struct | built |
| Immutable value object representing consistent options. More...
|
|
Options for collection::remove().
- 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
◆ cas()
Specifies a CAS value that will be taken into account on the server side for optimistic concurrency.
The CAS value is an opaque identifier which is associated with a specific state of the document on the server. The CAS value is received on read operations (or after mutations) and can be used during a subsequent mutation to make sure that the document has not been modified in the meantime.
If document on the server has been modified in the meantime the SDK will raise a errc::common::cas_mismatch
. In this case the caller is expected to re-do the whole "fetch-modify-update" cycle again. Please refer to the SDK documentation for more information on CAS mismatches and subsequent retries.
- Parameters
-
cas | the opaque CAS identifier to use for this operation. |
- Returns
- the
remove_options
for chaining purposes.
The documentation for this struct was generated from the following file: