search_metrics Class Reference

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

#include <couchbase/search_metrics.hxx>

Public Member Functions
	search_metrics ()=default
	search_metrics (std::chrono::nanoseconds took, std::uint64_t total_rows, std::uint64_t success_partition_count, std::uint64_t error_partition_count, std::uint64_t total_partition_count, double max_score)
auto	took () const -> std::chrono::nanoseconds
	The total time taken for the request, that is the time from when the request was received until the results were returned.
auto	total_rows () const -> std::uint64_t
auto	success_partition_count () const -> std::uint64_t
auto	error_partition_count () const -> std::uint64_t
auto	total_partition_count () const -> std::uint64_t
auto	max_score () const -> double

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_metrics() [1/2]

search_metrics ( )

default

Since

1.0.0

Internal

Internal interface

search_metrics() [2/2]

search_metrics ( std::chrono::nanoseconds took, std::uint64_t total_rows, std::uint64_t success_partition_count, std::uint64_t error_partition_count, std::uint64_t total_partition_count, double max_score )

inline

Since

1.0.0

Volatile

Should not be used in production

Member Function Documentation

error_partition_count()

auto error_partition_count ( ) const -> std::uint64_t

inlinenodiscard

Since

1.0.0

Committed

Generally available API and should be preferred in production

max_score()

auto max_score ( ) const -> double

inlinenodiscard

Since

1.0.0

Committed

Generally available API and should be preferred in production

success_partition_count()

auto success_partition_count ( ) const -> std::uint64_t

inlinenodiscard

Since

1.0.0

Committed

Generally available API and should be preferred in production

took()

auto took ( ) const -> std::chrono::nanoseconds

inlinenodiscard

The total time taken for the request, that is the time from when the request was received until the results were returned.

Returns

total time duration

Since

1.0.0

Committed

Generally available API and should be preferred in production

total_partition_count()

auto total_partition_count ( ) const -> std::uint64_t

inlinenodiscard

Since

1.0.0

Committed

Generally available API and should be preferred in production

total_rows()

auto total_rows ( ) const -> std::uint64_t

inlinenodiscard

Since

1.0.0

Committed

Generally available API and should be preferred in production

---

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

• couchbase/search_metrics.hxx