Couchbase C++ SDK 1.0.2 (rev. 51f4775)
Loading...
Searching...
No Matches
prefix_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
21
22#include <optional>
23#include <string>
24
25namespace couchbase
26{
42{
43public:
52 explicit prefix_query(std::string prefix)
53 : prefix_{ std::move(prefix) }
54 {
55 }
56
67 auto field(std::string field_name) -> prefix_query&
68 {
69 field_ = std::move(field_name);
70 return *this;
71 }
72
79 [[nodiscard]] auto encode() const -> encoded_search_query override;
80
81private:
82 std::string prefix_;
83 std::optional<std::string> field_{};
84};
85} // namespace couchbase
The prefix query finds documents containing terms that start with the provided prefix.
Definition prefix_query.hxx:42
prefix_query(std::string prefix)
Create a new prefix query.
Definition prefix_query.hxx:52
auto field(std::string field_name) -> prefix_query &
If a field is specified, only terms in that field will be matched.
Definition prefix_query.hxx:67
auto encode() const -> encoded_search_query override
Base class for full text search queries.
Definition search_query.hxx:33
Represents a single item from the result of collection::scan()
Definition allow_querying_search_index_options.hxx:28