Couchbase C++ SDK
1.4.0 (rev. 59aa900)
Toggle main menu visibility
Loading...
Searching...
No Matches
drop_primary_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
20
#include <
couchbase/common_options.hxx
>
21
#include <
couchbase/error_codes.hxx
>
22
23
#include <optional>
24
#include <string>
25
26
namespace
couchbase
27
{
28
class
drop_primary_query_index_options
:
public
common_options
<drop_primary_query_index_options>
29
{
30
public
:
38
auto
index_name
(std::string
index_name
) ->
drop_primary_query_index_options
&
39
{
40
index_name_.emplace(
index_name
);
41
return
self
();
42
}
43
54
auto
ignore_if_not_exists
(
bool
ignore_if_not_exists
) ->
drop_primary_query_index_options
&
55
{
56
ignore_if_not_exists_ =
ignore_if_not_exists
;
57
return
self
();
58
}
59
65
struct
built
:
public
common_options
<drop_primary_query_index_options>
::built
{
66
std::optional<std::string>
index_name
;
67
bool
ignore_if_not_exists
{};
68
};
69
81
[[nodiscard]]
auto
build
() const ->
built
82
{
83
return
{
build_common_options
(), index_name_, ignore_if_not_exists_ };
84
}
85
86
private
:
87
std::optional<std::string> index_name_{};
88
bool
ignore_if_not_exists_{
false
};
89
};
90
97
98
using
drop_primary_query_index_handler
= std::function<void(
error
)>;
99
}
// namespace couchbase
couchbase::common_options
Common options that used by most operations.
Definition
common_options.hxx:38
couchbase::common_options< drop_primary_query_index_options >::self
auto self() -> drop_primary_query_index_options &
Definition
common_options.hxx:116
couchbase::common_options< drop_primary_query_index_options >::build_common_options
auto build_common_options() const -> built
Definition
common_options.hxx:103
couchbase::drop_primary_query_index_options
Definition
drop_primary_query_index_options.hxx:29
couchbase::drop_primary_query_index_options::index_name
auto index_name(std::string index_name) -> drop_primary_query_index_options &
Name of the primary index.
Definition
drop_primary_query_index_options.hxx:38
couchbase::drop_primary_query_index_options::ignore_if_not_exists
auto ignore_if_not_exists(bool ignore_if_not_exists) -> drop_primary_query_index_options &
Set flag to ignore error if the index already exists.
Definition
drop_primary_query_index_options.hxx:54
couchbase::drop_primary_query_index_options::build
auto build() const -> built
Validates options and returns them as an immutable value.
Definition
drop_primary_query_index_options.hxx:81
couchbase::error
Definition
error.hxx:31
common_options.hxx
error_codes.hxx
couchbase
Represents a single item from the result of scan().
Definition
allow_querying_search_index_options.hxx:28
couchbase::drop_primary_query_index_handler
std::function< void(error)> drop_primary_query_index_handler
The signature for the handler of the get_all_indexes() operation.
Definition
drop_primary_query_index_options.hxx:98
couchbase::drop_primary_query_index_options::built
Immutable value object representing consistent options.
Definition
drop_primary_query_index_options.hxx:65
couchbase::drop_primary_query_index_options::built::ignore_if_not_exists
bool ignore_if_not_exists
Definition
drop_primary_query_index_options.hxx:67
couchbase::drop_primary_query_index_options::built::index_name
std::optional< std::string > index_name
Definition
drop_primary_query_index_options.hxx:66
couchbase
drop_primary_query_index_options.hxx
Generated by
1.17.0