Query Metrics contains the query result metrics containing counts and timings.
More...
#include <couchbase/query_metrics.hxx>
|
| | query_metrics ()=default |
| |
| | query_metrics (std::chrono::nanoseconds elapsed_time, std::chrono::nanoseconds execution_time, std::uint64_t result_count, std::uint64_t result_size, std::uint64_t sort_count, std::uint64_t mutation_count, std::uint64_t error_count, std::uint64_t warning_count) |
| |
| auto | elapsed_time () 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 | execution_time () const -> std::chrono::nanoseconds |
| | The time taken for the execution of the request, that is the time from when query execution started until the results were returned.
|
| |
| auto | result_count () const -> std::uint64_t |
| | The total number of objects in the results.
|
| |
| auto | result_size () const -> std::uint64_t |
| | The total number of bytes in the results.
|
| |
| auto | sort_count () const -> std::uint64_t |
| | The total number of results selected by the engine before restriction through LIMIT clause.
|
| |
| auto | mutation_count () const -> std::uint64_t |
| | The number of mutations that were made during the request.
|
| |
| auto | error_count () const -> std::uint64_t |
| | The number of errors that occurred during the request.
|
| |
| auto | warning_count () const -> std::uint64_t |
| | The number of warnings that occurred during the request.
|
| |
Query Metrics contains the query result metrics containing counts and timings.
- Since
- 1.0.0
- Committed
- Generally available API and should be preferred in production
◆ query_metrics() [1/2]
◆ query_metrics() [2/2]
| query_metrics |
( |
std::chrono::nanoseconds | elapsed_time, |
|
|
std::chrono::nanoseconds | execution_time, |
|
|
std::uint64_t | result_count, |
|
|
std::uint64_t | result_size, |
|
|
std::uint64_t | sort_count, |
|
|
std::uint64_t | mutation_count, |
|
|
std::uint64_t | error_count, |
|
|
std::uint64_t | warning_count ) |
|
inline |
- Since
- 1.0.0
- Volatile
- Should not be used in production
◆ elapsed_time()
| auto elapsed_time |
( |
| ) |
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
◆ error_count()
| auto error_count |
( |
| ) |
const -> std::uint64_t
|
|
inlinenodiscard |
The number of errors that occurred during the request.
- Returns
- number of errors
- Since
- 1.0.0
- Committed
- Generally available API and should be preferred in production
◆ execution_time()
| auto execution_time |
( |
| ) |
const -> std::chrono::nanoseconds
|
|
inlinenodiscard |
The time taken for the execution of the request, that is the time from when query execution started until the results were returned.
- Returns
- the execution time duration
- Since
- 1.0.0
- Committed
- Generally available API and should be preferred in production
◆ mutation_count()
| auto mutation_count |
( |
| ) |
const -> std::uint64_t
|
|
inlinenodiscard |
The number of mutations that were made during the request.
- Returns
- number of mutations
- Since
- 1.0.0
- Committed
- Generally available API and should be preferred in production
◆ result_count()
| auto result_count |
( |
| ) |
const -> std::uint64_t
|
|
inlinenodiscard |
The total number of objects in the results.
- Returns
- number of results
- Since
- 1.0.0
- Committed
- Generally available API and should be preferred in production
◆ result_size()
| auto result_size |
( |
| ) |
const -> std::uint64_t
|
|
inlinenodiscard |
The total number of bytes in the results.
- Returns
- number of bytes
- Since
- 1.0.0
- Committed
- Generally available API and should be preferred in production
◆ sort_count()
| auto sort_count |
( |
| ) |
const -> std::uint64_t
|
|
inlinenodiscard |
The total number of results selected by the engine before restriction through LIMIT clause.
- Returns
- number of results
- Since
- 1.0.0
- Committed
- Generally available API and should be preferred in production
◆ warning_count()
| auto warning_count |
( |
| ) |
const -> std::uint64_t
|
|
inlinenodiscard |
The number of warnings that occurred during the request.
- Returns
- number of warnings
- 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:
1.12.0