Search Metrics contains the search result metrics containing counts and timings. More...

#include <couchbase/search_row.hxx>

Public Member Functions
	search_row (internal_search_row internal)

	search_row (search_row &&other) noexcept

	~search_row ()

auto	operator= (search_row &&other) noexcept -> search_row &

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

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

auto	score () const -> double

auto	fields () const -> const codec::binary &

template<typename Serializer , typename Document = typename Serializer::document_type, std::enable_if_t< codec::is_serializer_v< Serializer >, bool > = true>
auto	fields_as () const -> Document

auto	explanation () const -> const codec::binary &

auto	locations () const -> const std::optional< search_row_locations > &

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

Detailed Description

Search Metrics contains the search result metrics containing counts and timings.

Since: 1.0.0

Committed: Generally available API and should be preferred in production

Constructor & Destructor Documentation

◆ search_row() [1/2]

search_row ( internal_search_row internal )

explicit

Since: 1.0.0

Volatile: Should not be used in production

◆ search_row() [2/2]

search_row ( search_row && other )

noexcept

◆ ~search_row()

~search_row ( )

Member Function Documentation

◆ explanation()

auto explanation ( ) const -> const codec::binary &

Since: 1.0.0

Committed: Generally available API and should be preferred in production

◆ fields()

auto fields ( ) const -> const codec::binary &

Since: 1.0.0

Committed: Generally available API and should be preferred in production

◆ fields_as()

template<typename Serializer , typename Document = typename Serializer::document_type, std::enable_if_t< codec::is_serializer_v< Serializer >, bool > = true>

auto fields_as ( ) const -> Document

inline

◆ fragments()

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

Since: 1.0.0

Committed: Generally available API and should be preferred in production

◆ id()

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

Since: 1.0.0

Committed: Generally available API and should be preferred in production

◆ index()

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

Since: 1.0.0

Committed: Generally available API and should be preferred in production

◆ locations()

auto locations ( ) const -> const std::optional< search_row_locations > &

Since: 1.0.0

Committed: Generally available API and should be preferred in production

◆ operator=()

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