Couchbase C++ SDK 1.0.2 (rev. 51f4775)
Loading...
Searching...
No Matches
search_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>
28
29#include <chrono>
30#include <functional>
31#include <memory>
32#include <optional>
33
34namespace couchbase
35{
36namespace codec
37{
38class tao_json_serializer;
39}
40
47struct search_options : public common_options<search_options> {
54 struct built : public common_options<search_options>::built {
55 std::optional<std::string> client_context_id{};
56 bool include_locations{ false };
57 bool disable_scoring{ false };
58 std::optional<bool> explain{};
59 std::optional<std::uint32_t> limit{};
60 std::optional<std::uint32_t> skip{};
61 std::vector<std::string> collections{};
62 std::vector<std::string> fields{};
63 std::vector<std::string> highlight_fields{};
64 std::optional<couchbase::highlight_style> highlight_style{};
65 std::optional<search_scan_consistency> scan_consistency{};
66 std::vector<mutation_token> mutation_state{};
67 std::map<std::string, codec::binary, std::less<>> raw{};
68 std::map<std::string, std::shared_ptr<search_facet>, std::less<>> facets{};
69 std::vector<std::shared_ptr<search_sort>> sort{};
70 std::vector<std::string> sort_string{};
71 };
72
84 [[nodiscard]] auto build() const -> built
85 {
86 return {
88 client_context_id_,
89 include_locations_,
90 disable_scoring_,
91 explain_,
92 limit_,
93 skip_,
94 collections_,
95 fields_,
96 highlight_fields_,
97 highlight_style_,
98 scan_consistency_,
99 mutation_state_,
100 raw_,
101 facets_,
102 sort_,
103 sort_string_,
104 };
105 }
106
120 {
121 if (client_context_id.empty()) {
122 client_context_id_.reset();
123 } else {
124 client_context_id_ = std::move(client_context_id);
125 }
126 return self();
127 }
128
150 {
151 scan_consistency_ = scan_consistency;
152 mutation_state_.clear();
153 return self();
154 }
155
174 {
175 mutation_state_ = state.tokens();
176 scan_consistency_.reset();
177 return self();
178 }
179
190 template<typename Value,
191 typename Serializer = codec::tao_json_serializer,
192 std::enable_if_t<codec::is_serializer_v<Serializer>, bool> = true>
193 auto raw(std::string name, const Value& value) -> search_options&
194 {
195 raw_[std::move(name)] = std::move(Serializer::template serialize(value));
196 return self();
197 }
198
208 auto skip(std::uint32_t skip) -> search_options&
209 {
210 skip_ = skip;
211 return self();
212 }
213
224 auto limit(std::uint32_t limit) -> search_options&
225 {
226 limit_ = limit;
227 return self();
228 }
229
241 {
242 explain_ = explain;
243 return self();
244 }
245
255 auto disable_scoring(bool disable) -> search_options&
256 {
257 disable_scoring_ = disable;
258 return self();
259 }
260
270 auto include_locations(bool include) -> search_options&
271 {
272 include_locations_ = include;
273 return self();
274 }
275
287 auto collections(std::vector<std::string> collections) -> search_options&
288 {
289 collections_ = std::move(collections);
290 return self();
291 }
292
307 auto fields(std::vector<std::string> fields) -> search_options&
308 {
309 fields_ = std::move(fields);
310 return self();
311 }
312
329 std::vector<std::string> fields = {}) -> search_options&
330 {
331 highlight_style_ = style;
332 highlight_fields_ = std::move(fields);
333 return self();
334 }
335
351 auto highlight(std::vector<std::string> fields) -> search_options&
352 {
353 highlight_style_ = highlight_style::html;
354 highlight_fields_ = std::move(fields);
355 return self();
356 }
357
378 auto sort(std::vector<std::string> sort_expressions) -> search_options&
379 {
380 sort_string_ = std::move(sort_expressions);
381 return self();
382 }
383
397 auto sort(std::vector<std::shared_ptr<search_sort>> sort_objects) -> search_options&
398 {
399 sort_ = std::move(sort_objects);
400 return self();
401 }
402
416 auto facets(std::map<std::string, std::shared_ptr<search_facet>> facets) -> search_options&
417 {
418 facets_.clear();
419 for (auto& [name, facet] : facets) {
420 facets_[name] = std::move(facet);
421 }
422 return self();
423 }
424
438 template<typename... Facets>
439 auto facets(const Facets&... facets) -> search_options&
440 {
441 facets_.clear();
442 encode_facet(facets...);
443 return self();
444 }
445
463 auto facet(std::string name, std::shared_ptr<search_facet> facet) -> search_options&
464 {
465 facets_[std::move(name)] = std::move(facet);
466 return self();
467 }
468
487 template<typename Facet>
488 auto facet(std::string name, Facet facet) -> search_options&
489 {
490 facets_[std::move(name)] = std::make_shared<Facet>(std::move(facet));
491 return self();
492 }
493
494private:
495 template<typename Name, typename Facet, typename... Rest>
496 void encode_facet(const std::pair<Name, Facet>& facet, Rest... args)
497 {
498 facets_[std::move(facet.first)] = std::make_shared<Facet>(std::move(facet.second));
499 if constexpr (sizeof...(args) > 0) {
500 encode_facet(args...);
501 }
502 }
503
504 std::optional<std::string> client_context_id_{};
505 bool include_locations_{ false };
506 bool disable_scoring_{ false };
507 std::optional<bool> explain_{};
508 std::optional<std::uint32_t> limit_{};
509 std::optional<std::uint32_t> skip_{};
510 std::vector<std::string> collections_{};
511 std::vector<std::string> fields_{};
512 std::vector<std::string> highlight_fields_{};
513 std::optional<highlight_style> highlight_style_{};
514 std::optional<search_scan_consistency> scan_consistency_{};
515 std::vector<mutation_token> mutation_state_{};
516 std::map<std::string, codec::binary, std::less<>> raw_{};
517 std::map<std::string, std::shared_ptr<search_facet>, std::less<>> facets_{};
518 std::vector<std::shared_ptr<search_sort>> sort_{};
519 std::vector<std::string> sort_string_{};
520};
521
528using search_handler = std::function<void(error, search_result)>;
529} // namespace couchbase
Definition tao_json_serializer.hxx:42
Common options that used by most operations.
Definition common_options.hxx:37
auto self() -> search_options &
Definition common_options.hxx:102
auto build_common_options() const -> built
Definition common_options.hxx:89
Definition error.hxx:30
Aggregation of one or more mutation_tokens for specifying consistency requirements of N1QL or FTS que...
Definition mutation_state.hxx:35
Represents result of cluster::search() and scope::search() calls.
Definition search_result.hxx:45
Represents a single item from the result of collection::scan()
Definition allow_querying_search_index_options.hxx:28
std::function< void(error, search_result)> search_handler
The signature for the handler of the cluster::search() and scope::search() operations.
Definition search_options.hxx:528
highlight_style
Enumeration of the highlighting styles recognized by the FTS engine.
Definition highlight_style.hxx:28
@ html
Use HTML tags <mark> and </mark> to indicate matches in the fields.
search_scan_consistency
Definition search_scan_consistency.hxx:22
Immutable value object representing consistent options.
Definition search_options.hxx:54
std::vector< std::string > highlight_fields
Definition search_options.hxx:63
std::optional< bool > explain
Definition search_options.hxx:58
std::vector< std::string > collections
Definition search_options.hxx:61
std::map< std::string, codec::binary, std::less<> > raw
Definition search_options.hxx:67
std::optional< std::string > client_context_id
Definition search_options.hxx:55
std::map< std::string, std::shared_ptr< search_facet >, std::less<> > facets
Definition search_options.hxx:68
bool include_locations
Definition search_options.hxx:56
std::optional< search_scan_consistency > scan_consistency
Definition search_options.hxx:65
std::vector< std::shared_ptr< search_sort > > sort
Definition search_options.hxx:69
std::vector< std::string > fields
Definition search_options.hxx:62
std::optional< std::uint32_t > skip
Definition search_options.hxx:60
std::optional< std::uint32_t > limit
Definition search_options.hxx:59
bool disable_scoring
Definition search_options.hxx:57
std::vector< std::string > sort_string
Definition search_options.hxx:70
Options for cluster::search() and scope::search().
Definition search_options.hxx:47
auto skip(std::uint32_t skip) -> search_options &
Set the number of rows to skip (eg.
Definition search_options.hxx:208
auto highlight(highlight_style style=highlight_style::html, std::vector< std::string > fields={}) -> search_options &
Configures the highlighting of matches in the response.
Definition search_options.hxx:328
auto fields(std::vector< std::string > fields) -> search_options &
Configures the list of fields for which the whole value should be included in the response.
Definition search_options.hxx:307
auto explain(bool explain) -> search_options &
Activates or deactivates the explanation of each result hit in the response, according to the paramet...
Definition search_options.hxx:240
auto facet(std::string name, Facet facet) -> search_options &
Adds one search_facet to the query.
Definition search_options.hxx:488
auto facet(std::string name, std::shared_ptr< search_facet > facet) -> search_options &
Adds one search_facet to the query.
Definition search_options.hxx:463
auto sort(std::vector< std::shared_ptr< search_sort > > sort_objects) -> search_options &
Configures the list of search_sort instances which are used for sorting purposes.
Definition search_options.hxx:397
auto highlight(std::vector< std::string > fields) -> search_options &
Configures the highlighting of matches in the response for all fields, using the server's default hig...
Definition search_options.hxx:351
auto consistent_with(const mutation_state &state) -> search_options &
Sets the mutation_tokens this query should be consistent with.
Definition search_options.hxx:173
auto scan_consistency(search_scan_consistency scan_consistency) -> search_options &
Customizes the consistency guarantees for this query.
Definition search_options.hxx:149
auto sort(std::vector< std::string > sort_expressions) -> search_options &
Configures the list of fields (including special fields) which are used for sorting purposes.
Definition search_options.hxx:378
auto build() const -> built
Validates options and returns them as an immutable value.
Definition search_options.hxx:84
auto facets(std::map< std::string, std::shared_ptr< search_facet > > facets) -> search_options &
Sets list of search_facet to the query.
Definition search_options.hxx:416
auto disable_scoring(bool disable) -> search_options &
If set to true, thee server will not perform any scoring on the hits.
Definition search_options.hxx:255
auto include_locations(bool include) -> search_options &
If set to true, will include the search_row::locations().
Definition search_options.hxx:270
auto limit(std::uint32_t limit) -> search_options &
Add a limit to the query on the number of rows it can return.
Definition search_options.hxx:224
auto facets(const Facets &... facets) -> search_options &
Sets list of search_facet to the query.
Definition search_options.hxx:439
auto client_context_id(std::string client_context_id) -> search_options &
Supports providing a custom client context ID for this query.
Definition search_options.hxx:119
auto collections(std::vector< std::string > collections) -> search_options &
Allows to limit the search query to a specific list of collection names.
Definition search_options.hxx:287
auto raw(std::string name, const Value &value) -> search_options &
Definition search_options.hxx:193