Options for collection::upsert().
More...
#include <couchbase/upsert_options.hxx>
|
struct | built |
| Immutable value object representing consistent options. More...
|
|
Options for collection::upsert().
- Since
- 1.0.0
- Committed
- Generally available API and should be preferred in production
- Examples
- distributed_mutex.cxx.
◆ 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
◆ expiry() [1/2]
Sets the expiry for the document.
By default the document will never expire.
The duration must be less than 50 years. For expiry further in the future, use expiry(std::chrono::system_clock::time_point)
.
- Parameters
-
duration | the duration after which the document will expire (zero duration means never expire). |
- Returns
- this options class for chaining purposes.
- Since
- 1.0.0
- Committed
- Generally available API and should be preferred in production
◆ expiry() [2/2]
auto expiry |
( |
std::chrono::system_clock::time_point | time_point | ) |
-> upsert_options&
|
|
inline |
Sets the expiry for the document.
By default the document will never expire.
- Parameters
-
time_point | the point in time when the document will expire (epoch second zero means never expire). |
- Returns
- this options class for chaining purposes.
- Since
- 1.0.0
- Committed
- Generally available API and should be preferred in production
◆ preserve_expiry()
Specifies whether an existing document's expiry should be preserved.
Defaults to false.
If true, and the document exists, its expiry will not be modified. Otherwise the document's expiry is determined by expiry(std::chrono::seconds)
or expiry(std::chrono::system_clock::time_point)
.
Requires Couchbase Server 7.0 or later.
- Parameters
-
preserve | true to preserve expiry, false to set new expiry |
- Returns
- this options class 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: