search_meta_data Class Reference

Stores any non-rows results related to the execution of a particular N1QL search. More...

#include <couchbase/search_meta_data.hxx>

Public Member Functions
	search_meta_data (internal_search_meta_data internal)
	search_meta_data (search_meta_data &&other) noexcept
	~search_meta_data ()
auto	operator= (search_meta_data &&other) noexcept -> search_meta_data &
auto	client_context_id () const -> const std::string &
	Returns the client context identifier string set on the search request.
auto	errors () const -> const std::map< std::string, std::string > &
	Returns any warnings returned by the search engine.
auto	metrics () const -> const search_metrics &
	Returns the search_metrics as returned by the search engine if enabled.

Detailed Description

Stores any non-rows results related to the execution of a particular N1QL search.

Since

1.0.0

Committed

Generally available API and should be preferred in production

Constructor & Destructor Documentation

search_meta_data() [1/2]

search_meta_data ( internal_search_meta_data internal )

explicit

Since

1.0.0

Volatile

Should not be used in production

search_meta_data() [2/2]

search_meta_data ( search_meta_data && other )

noexcept

~search_meta_data()

~search_meta_data

(

)

Member Function Documentation

client_context_id()

auto client_context_id ( ) const -> const std::string &

nodiscard

Returns the client context identifier string set on the search request.

Returns

client context identifier

Since

1.0.0

Committed

Generally available API and should be preferred in production

errors()

auto errors ( ) const -> const std::map< std::string, std::string > &

nodiscard

Returns any warnings returned by the search engine.

It returns an empty vector if no warnings were returned.

Returns

vector of the reported warnings.

Since

1.0.0

Committed

Generally available API and should be preferred in production

metrics()

auto metrics ( ) const -> const search_metrics &

nodiscard

Returns the search_metrics as returned by the search engine if enabled.

Returns

metrics

Since

1.0.0

Committed

Generally available API and should be preferred in production

operator=()

auto operator= ( search_meta_data && other ) -> search_meta_data &

noexcept

---

The documentation for this class was generated from the following file:

• couchbase/search_meta_data.hxx