Couchbase C++ SDK
1.4.0 (rev. 59aa900)
Toggle main menu visibility
Loading...
Searching...
No Matches
search_meta_data.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
20
#include <
couchbase/codec/json_transcoder.hxx
>
21
#include <
couchbase/search_metrics.hxx
>
22
23
#include <cinttypes>
24
#include <map>
25
#include <memory>
26
#include <optional>
27
#include <vector>
28
29
namespace
couchbase
30
{
31
#ifndef COUCHBASE_CXX_CLIENT_DOXYGEN
32
class
internal_search_meta_data;
33
#endif
34
41
class
search_meta_data
42
{
43
public
:
48
explicit
search_meta_data
(internal_search_meta_data internal);
49
search_meta_data
(
search_meta_data
&& other)
noexcept
;
50
~search_meta_data
();
51
auto
operator=
(
search_meta_data
&& other)
noexcept
->
search_meta_data
&;
52
61
[[nodiscard]]
auto
client_context_id
() const -> const std::
string
&;
72
[[nodiscard]] auto
errors
() const -> const std::map<std::
string
, std::
string
>&;
73
82
[[nodiscard]] auto
metrics
() const -> const
search_metrics
&;
83
84
private:
85
std::unique_ptr<internal_search_meta_data> internal_;
86
};
87
88
}
// namespace couchbase
couchbase::search_meta_data::operator=
auto operator=(search_meta_data &&other) noexcept -> search_meta_data &
couchbase::search_meta_data::client_context_id
auto client_context_id() const -> const std::string &
Returns the client context identifier string set on the search request.
couchbase::search_meta_data::~search_meta_data
~search_meta_data()
couchbase::search_meta_data::errors
auto errors() const -> const std::map< std::string, std::string > &
Returns any warnings returned by the search engine.
couchbase::search_meta_data::search_meta_data
search_meta_data(internal_search_meta_data internal)
couchbase::search_meta_data::search_meta_data
search_meta_data(search_meta_data &&other) noexcept
couchbase::search_meta_data::metrics
auto metrics() const -> const search_metrics &
Returns the search_metrics as returned by the search engine if enabled.
couchbase::search_metrics
Search Metrics contains the search result metrics containing counts and timings.
Definition
search_metrics.hxx:33
json_transcoder.hxx
couchbase
Represents a single item from the result of scan().
Definition
allow_querying_search_index_options.hxx:28
search_metrics.hxx
couchbase
search_meta_data.hxx
Generated by
1.17.0