Couchbase C++ SDK
1.4.0 (rev. 59aa900)
Toggle main menu visibility
Loading...
Searching...
No Matches
lookup_in_all_replicas_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/subdoc/fwd/command_bundle.hxx
>
21
22
#include <
couchbase/codec/encoded_value.hxx
>
23
#include <
couchbase/common_options.hxx
>
24
#include <
couchbase/error.hxx
>
25
#include <
couchbase/expiry.hxx
>
26
#include <
couchbase/lookup_in_replica_result.hxx
>
27
#include <
couchbase/read_preference.hxx
>
28
#include <
couchbase/store_semantics.hxx
>
29
30
#include <functional>
31
#include <vector>
32
33
namespace
couchbase
34
{
41
struct
lookup_in_all_replicas_options
:
common_options
<lookup_in_all_replicas_options> {
48
struct
built
:
public
common_options
<lookup_in_all_replicas_options>
::built
{
49
couchbase::read_preference
read_preference
;
50
};
51
63
auto
read_preference
(
read_preference
preference) ->
lookup_in_all_replicas_options
&
64
{
65
read_preference_ = preference;
66
return
self
();
67
}
68
80
[[nodiscard]]
auto
build
() const ->
built
81
{
82
return
{
83
build_common_options
(),
84
read_preference_,
85
};
86
}
87
88
private
:
89
couchbase::read_preference
read_preference_{
read_preference::no_preference
};
90
};
91
98
using
lookup_in_all_replicas_result
= std::vector<lookup_in_replica_result>;
99
106
using
lookup_in_all_replicas_handler
= std::function<void(
error
,
lookup_in_all_replicas_result
)>;
107
108
#ifndef COUCHBASE_CXX_CLIENT_DOXYGEN
109
namespace
core
110
{
111
class
cluster
;
112
113
namespace
impl::subdoc
114
{
115
struct
command;
116
}
// namespace impl::subdoc
117
#endif
118
119
}
// namespace core
120
}
// namespace couchbase
couchbase::cluster
The cluster is the main entry point when connecting to a Couchbase cluster.
Definition
cluster.hxx:62
couchbase::common_options
Common options that used by most operations.
Definition
common_options.hxx:38
couchbase::common_options< lookup_in_all_replicas_options >::self
auto self() -> lookup_in_all_replicas_options &
Definition
common_options.hxx:116
couchbase::common_options< lookup_in_all_replicas_options >::build_common_options
auto build_common_options() const -> built
Definition
common_options.hxx:103
couchbase::error
Definition
error.hxx:31
command_bundle.hxx
common_options.hxx
encoded_value.hxx
error.hxx
expiry.hxx
lookup_in_replica_result.hxx
couchbase::core
Definition
expiry.hxx:24
couchbase
Represents a single item from the result of scan().
Definition
allow_querying_search_index_options.hxx:28
couchbase::lookup_in_all_replicas_result
std::vector< lookup_in_replica_result > lookup_in_all_replicas_result
The result for the lookup_in_all_replicas() operation.
Definition
lookup_in_all_replicas_options.hxx:98
couchbase::read_preference
read_preference
Select read preference (or affinity) for the replica APIs such as:
Definition
read_preference.hxx:39
couchbase::read_preference::no_preference
@ no_preference
Do not enforce any filtering for replica set.
Definition
read_preference.hxx:43
couchbase::lookup_in_all_replicas_handler
std::function< void(error, lookup_in_all_replicas_result)> lookup_in_all_replicas_handler
The signature for the handler of the lookup_in_all_replicas() operation.
Definition
lookup_in_all_replicas_options.hxx:106
read_preference.hxx
store_semantics.hxx
couchbase::lookup_in_all_replicas_options::built
Immutable value object representing consistent options.
Definition
lookup_in_all_replicas_options.hxx:48
couchbase::lookup_in_all_replicas_options::built::read_preference
couchbase::read_preference read_preference
Definition
lookup_in_all_replicas_options.hxx:49
couchbase::lookup_in_all_replicas_options
Options for lookup_in_all_replicas().
Definition
lookup_in_all_replicas_options.hxx:41
couchbase::lookup_in_all_replicas_options::read_preference
auto read_preference(read_preference preference) -> lookup_in_all_replicas_options &
Choose how the replica nodes will be selected.
Definition
lookup_in_all_replicas_options.hxx:63
couchbase::lookup_in_all_replicas_options::build
auto build() const -> built
Validates options and returns them as an immutable value.
Definition
lookup_in_all_replicas_options.hxx:80
couchbase
lookup_in_all_replicas_options.hxx
Generated by
1.17.0