Couchbase C++ SDK 1.0.2 (rev. 51f4775)
Loading...
Searching...
No Matches
search_query.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 2023-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 <cstdint>
21#include <optional>
22
23namespace couchbase
24{
25#ifndef COUCHBASE_CXX_CLIENT_DOXYGEN
26struct encoded_search_query;
27#endif
28
33{
34public:
35 virtual ~search_query() = default;
36
50 template<typename derived_query = search_query,
51 std::enable_if_t<std::is_base_of_v<search_query, derived_query>, bool> = true>
52 auto boost(double boost) -> derived_query&
53 {
54 boost_ = boost;
55 return *static_cast<derived_query*>(this);
56 }
57
64 [[nodiscard]] virtual auto encode() const -> encoded_search_query = 0;
65
66protected:
67 search_query() = default;
68
69 std::optional<double> boost_{};
70};
71} // namespace couchbase
Base class for full text search queries.
Definition search_query.hxx:33
auto boost(double boost) -> derived_query &
The boost parameter is used to increase the relative weight of a clause (with a boost greater than 1)...
Definition search_query.hxx:52
std::optional< double > boost_
Definition search_query.hxx:69
virtual auto encode() const -> encoded_search_query=0
virtual ~search_query()=default
Represents a single item from the result of collection::scan()
Definition allow_querying_search_index_options.hxx:28