Couchbase C++ SDK
1.4.0 (rev. 59aa900)
Toggle main menu visibility
Loading...
Searching...
No Matches
phrase_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 <
couchbase/search_query.hxx
>
21
22
#include <optional>
23
#include <stdexcept>
24
#include <string>
25
#include <vector>
26
27
namespace
couchbase
28
{
45
class
phrase_query
:
public
search_query
46
{
47
public
:
60
explicit
phrase_query
(std::initializer_list<std::string> terms)
61
: terms_{ terms }
62
{
63
if
(terms_.empty()) {
64
throw
std::invalid_argument(
"terms must not be empty in phrase_query"
);
65
}
66
}
67
80
explicit
phrase_query
(std::vector<std::string> terms)
81
: terms_{ std::move(terms) }
82
{
83
if
(terms_.empty()) {
84
throw std::invalid_argument(
"terms must not be empty in phrase_query"
);
85
}
86
}
87
98
auto
field
(std::string field_name) ->
phrase_query
&
99
{
100
field_ = std::move(field_name);
101
return
*
this
;
102
}
103
110
[[nodiscard]]
auto
encode
() const -> encoded_search_query override;
111
112
private:
113
std::vector<std::
string
> terms_;
114
std::optional<std::
string
> field_{};
115
};
116
}
// namespace couchbase
couchbase::phrase_query::phrase_query
phrase_query(std::vector< std::string > terms)
Create a new phrase query.
Definition
phrase_query.hxx:80
couchbase::phrase_query::encode
auto encode() const -> encoded_search_query override
couchbase::phrase_query::phrase_query
phrase_query(std::initializer_list< std::string > terms)
Create a new phrase query.
Definition
phrase_query.hxx:60
couchbase::phrase_query::field
auto field(std::string field_name) -> phrase_query &
If a field is specified, only terms in that field will be matched.
Definition
phrase_query.hxx:98
couchbase::search_query::search_query
search_query()=default
couchbase
Represents a single item from the result of scan().
Definition
allow_querying_search_index_options.hxx:28
search_query.hxx
couchbase
phrase_query.hxx
Generated by
1.17.0