Couchbase C++ SDK 1.0.2 (rev. 51f4775)
Loading...
Searching...
No Matches
search_result.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
25
26#include <chrono>
27#include <cinttypes>
28#include <optional>
29#include <vector>
30
31namespace couchbase
32{
33#ifndef COUCHBASE_CXX_CLIENT_DOXYGEN
34class internal_search_result;
35#endif
36
45{
46public:
52 explicit search_result(internal_search_result internal);
54
55 search_result(const search_result&) = delete;
57
59 search_result& operator=(search_result&&) noexcept;
60
70 [[nodiscard]] auto meta_data() const -> const search_meta_data&;
71
72 [[nodiscard]] auto rows() const -> const std::vector<search_row>&;
73
74 [[nodiscard]] auto facets() const
75 -> const std::map<std::string, std::shared_ptr<search_facet_result>>&;
76
77private:
78 std::unique_ptr<internal_search_result> internal_;
79};
80} // namespace couchbase
Definition search_facet_result.hxx:30
Stores any non-rows results related to the execution of a particular N1QL search.
Definition search_meta_data.hxx:42
Represents result of cluster::search() and scope::search() calls.
Definition search_result.hxx:45
auto meta_data() const -> const search_meta_data &
Returns the search_meta_data giving access to the additional metadata associated with this search.
search_result(const search_result &)=delete
search_result(internal_search_result internal)
search_result(search_result &&) noexcept
auto rows() const -> const std::vector< search_row > &
search_result & operator=(const search_result &)=delete
auto facets() const -> const std::map< std::string, std::shared_ptr< search_facet_result > > &
Search Metrics contains the search result metrics containing counts and timings.
Definition search_row.hxx:39
Represents a single item from the result of collection::scan()
Definition allow_querying_search_index_options.hxx:28