Couchbase C++ SDK 1.0.2 (rev. 51f4775)
Loading...
Searching...
No Matches
build_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 <functional>
25#include <optional>
26#include <string>
27
28namespace couchbase
29{
36class build_query_index_options : public common_options<build_query_index_options>
37{
38public:
39 struct built : public common_options<build_query_index_options>::built {
40 const std::optional<std::string> scope_name{};
41 const std::optional<std::string> collection_name{};
42 };
43
55 [[nodiscard]] auto build() const -> built
56 {
57
58 return { build_common_options() };
59 }
60};
61
68using build_deferred_query_indexes_handler = std::function<void(error)>;
69} // namespace couchbase
Options for query_index_manager::build_deferred_indexes().
Definition build_query_index_options.hxx:37
auto build() const -> built
Validates options and returns them as an immutable value.
Definition build_query_index_options.hxx:55
Common options that used by most operations.
Definition common_options.hxx:37
auto build_common_options() const -> built
Definition common_options.hxx:89
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)> build_deferred_query_indexes_handler
The signature for the handler of the query_index_manager::build_deferred_indexes() operation.
Definition build_query_index_options.hxx:68
Definition build_query_index_options.hxx:39
const std::optional< std::string > collection_name
Definition build_query_index_options.hxx:41
const std::optional< std::string > scope_name
Definition build_query_index_options.hxx:40