Couchbase C++ SDK 1.0.2 (rev. 51f4775)
Loading...
Searching...
No Matches
doc_id_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 <string>
23#include <vector>
24
25namespace couchbase
26{
35{
36public:
37 doc_id_query() = default;
38
47 explicit doc_id_query(std::vector<std::string> ids)
48 : ids_{ std::move(ids) }
49 {
50 }
51
60 doc_id_query(std::initializer_list<std::string> ids)
61 {
62 ids_.reserve(ids.size());
63 doc_ids(ids);
64 }
65
76 auto doc_ids(const std::vector<std::string>& ids) -> doc_id_query&
77 {
78 for (const auto& id : ids) {
79 ids_.push_back(id);
80 }
81 return *this;
82 }
83
94 auto doc_id(const std::string& id) -> doc_id_query&
95 {
96 ids_.push_back(id);
97 return *this;
98 }
99
106 [[nodiscard]] auto encode() const -> encoded_search_query override;
107
108private:
109 std::vector<std::string> ids_{};
110};
111} // namespace couchbase
A doc_id query is a query that directly matches the documents whose ID have been provided.
Definition doc_id_query.hxx:35
doc_id_query(std::initializer_list< std::string > ids)
Create a new doc_id query.
Definition doc_id_query.hxx:60
auto doc_id(const std::string &id) -> doc_id_query &
Add ID to the query.
Definition doc_id_query.hxx:94
doc_id_query(std::vector< std::string > ids)
Create a new doc_id query.
Definition doc_id_query.hxx:47
auto encode() const -> encoded_search_query override
auto doc_ids(const std::vector< std::string > &ids) -> doc_id_query &
Add IDs to the query.
Definition doc_id_query.hxx:76
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