Couchbase C++ SDK
1.4.0 (rev. 59aa900)
Toggle main menu visibility
Loading...
Searching...
No Matches
insert_options.hxx
Go to the documentation of this file.
1
/* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
2
/*
3
* Copyright 2020-Present Couchbase, Inc.
4
*
5
* Licensed under the Apache License, Version 2.0 (the "License");
6
* you may not use this file except in compliance with the License.
7
* You may obtain a copy of the License at
8
*
9
* http://www.apache.org/licenses/LICENSE-2.0
10
*
11
* Unless required by applicable law or agreed to in writing, software
12
* distributed under the License is distributed on an "AS IS" BASIS,
13
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
* See the License for the specific language governing permissions and
15
* limitations under the License.
16
*/
17
18
#pragma once
19
20
#include <
couchbase/codec/encoded_value.hxx
>
21
#include <
couchbase/common_durability_options.hxx
>
22
#include <
couchbase/error.hxx
>
23
#include <
couchbase/expiry.hxx
>
24
#include <
couchbase/mutation_result.hxx
>
25
26
#include <chrono>
27
#include <functional>
28
#include <memory>
29
#include <optional>
30
#include <vector>
31
32
namespace
couchbase
33
{
34
41
struct
insert_options
:
public
common_durability_options
<insert_options> {
48
struct
built
:
public
common_durability_options
<insert_options>
::built
{
49
const
std::uint32_t
expiry
;
50
};
51
63
[[nodiscard]]
auto
build
() const ->
built
64
{
65
auto
base =
build_common_durability_options
();
66
return
{ base, expiry_ };
67
}
68
82
auto
expiry
(std::chrono::seconds duration) ->
insert_options
&
83
{
84
expiry_ = core::impl::expiry_relative(duration);
85
return
self
();
86
}
87
98
auto
expiry
(std::chrono::system_clock::time_point time_point) ->
insert_options
&
99
{
100
expiry_ = core::impl::expiry_absolute(time_point);
101
return
self
();
102
}
103
104
private
:
105
std::uint32_t expiry_{ 0 };
106
};
107
114
using
insert_handler
= std::function<void(
error
,
mutation_result
)>;
115
}
// namespace couchbase
couchbase::common_durability_options
Common options that used by most operations.
Definition
common_durability_options.hxx:39
couchbase::common_durability_options< insert_options >::build_common_durability_options
auto build_common_durability_options() const -> built
Definition
common_durability_options.hxx:115
couchbase::common_options< insert_options >::self
auto self() -> insert_options &
Definition
common_options.hxx:116
couchbase::error
Definition
error.hxx:31
couchbase::mutation_result
Represents result of mutation operations.
Definition
mutation_result.hxx:35
common_durability_options.hxx
encoded_value.hxx
error.hxx
expiry.hxx
mutation_result.hxx
couchbase
Represents a single item from the result of scan().
Definition
allow_querying_search_index_options.hxx:28
couchbase::insert_handler
std::function< void(error, mutation_result)> insert_handler
The signature for the handler of the insert() operation.
Definition
insert_options.hxx:114
couchbase::insert_options::built
Immutable value object representing consistent options.
Definition
insert_options.hxx:48
couchbase::insert_options::built::expiry
const std::uint32_t expiry
Definition
insert_options.hxx:49
couchbase::insert_options
Options for insert().
Definition
insert_options.hxx:41
couchbase::insert_options::expiry
auto expiry(std::chrono::seconds duration) -> insert_options &
Sets the expiry for the document.
Definition
insert_options.hxx:82
couchbase::insert_options::expiry
auto expiry(std::chrono::system_clock::time_point time_point) -> insert_options &
Sets the expiry for the document.
Definition
insert_options.hxx:98
couchbase::insert_options::build
auto build() const -> built
Validates options and returns them as an immutable value.
Definition
insert_options.hxx:63
couchbase
insert_options.hxx
Generated by
1.17.0