Couchbase C++ SDK 1.0.2 (rev. 51f4775)
Loading...
Searching...
No Matches
create_query_index_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
21#include <couchbase/error.hxx>
23
24#include <optional>
25#include <string>
26
27namespace couchbase
28{
29class create_query_index_options : public common_options<create_query_index_options>
30{
31public:
44 {
45 ignore_if_exists_ = ignore_if_exists;
46 return self();
47 }
60 {
61 deferred_ = deferred;
62 return self();
63 }
64
76 {
77 num_replicas_ = num_replicas;
78 return self();
79 }
89 {
90 condition_.emplace(std::move(condition));
91 return self();
92 }
93
100 struct built : public common_options<create_query_index_options>::built {
102 bool deferred{};
103 std::optional<std::string> condition{};
104 std::optional<uint8_t> num_replicas{};
105 };
106
118 [[nodiscard]] auto build() const -> built
119 {
120 return { build_common_options(), ignore_if_exists_, deferred_, condition_, num_replicas_ };
121 }
122
123private:
124 std::optional<std::string> scope_name_{};
125 std::optional<std::string> collection_name_{};
126 bool ignore_if_exists_{ false };
127 bool deferred_{ false };
128 std::optional<uint8_t> num_replicas_{};
129 std::optional<std::string> condition_{};
130};
131
139using create_query_index_handler = std::function<void(error)>;
140} // namespace couchbase
Common options that used by most operations.
Definition common_options.hxx:37
auto self() -> create_query_index_options &
Definition common_options.hxx:102
auto build_common_options() const -> built
Definition common_options.hxx:89
Definition create_query_index_options.hxx:30
auto num_replicas(uint8_t num_replicas) -> create_query_index_options &
Set the number of replicas the index will have.
Definition create_query_index_options.hxx:75
auto build() const -> built
Validates options and returns them as an immutable value.
Definition create_query_index_options.hxx:118
auto ignore_if_exists(bool ignore_if_exists) -> create_query_index_options &
Set flag to ignore error if the index already exists.
Definition create_query_index_options.hxx:43
auto condition(std::string condition) -> create_query_index_options &
Supply an extra condition on this index.
Definition create_query_index_options.hxx:88
auto build_deferred(bool deferred) -> create_query_index_options &
Set flag to defer building of the index.
Definition create_query_index_options.hxx:59
Definition error.hxx:30
Represents a single item from the result of collection::scan()
Definition allow_querying_search_index_options.hxx:28
std::function< void(error)> create_query_index_handler
The signature for the handler of the query_index_manager::get_all_indexes() operation.
Definition create_query_index_options.hxx:139
Immutable value object representing consistent options.
Definition create_query_index_options.hxx:100
std::optional< uint8_t > num_replicas
Definition create_query_index_options.hxx:104
bool deferred
Definition create_query_index_options.hxx:102
std::optional< std::string > condition
Definition create_query_index_options.hxx:103
bool ignore_if_exists
Definition create_query_index_options.hxx:101