analytics_meta_data Class Reference

Stores any non-rows results related to the execution of a particular Analytics query. More...

#include <couchbase/analytics_meta_data.hxx>

Public Member Functions
	analytics_meta_data ()=default
	analytics_meta_data (std::string request_id, std::string client_context_id, analytics_status status, std::vector< analytics_warning > warnings, analytics_metrics metrics, std::optional< codec::binary > signature)
auto	request_id () const -> const std::string &
	Returns the request identifier string of the query request.
auto	client_context_id () const -> const std::string &
	Returns the client context identifier string set on the query request.
auto	status () const -> analytics_status
	Returns the raw query execution status as returned by the query engine.
auto	warnings () const -> const std::vector< analytics_warning > &
	Returns any warnings returned by the analytics engine.
auto	metrics () const -> const analytics_metrics &
	Returns the analytics_metrics as returned by the analytics engine if enabled.
auto	signature () const -> const std::optional< codec::binary > &
	Returns the signature as returned by the analytics engine.

Detailed Description

Stores any non-rows results related to the execution of a particular Analytics query.

Since

1.0.0

Committed

Generally available API and should be preferred in production

Constructor & Destructor Documentation

analytics_meta_data() [1/2]

analytics_meta_data ( )

default

Since

1.0.0

Internal

Internal interface

analytics_meta_data() [2/2]

analytics_meta_data ( std::string request_id, std::string client_context_id, analytics_status status, std::vector< analytics_warning > warnings, analytics_metrics metrics, std::optional< codec::binary > signature )

inline

Since

1.0.0

Volatile

Should not be used in production

Member Function Documentation

client_context_id()

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

inlinenodiscard

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

Returns

client context identifier

Since

1.0.0

Committed

Generally available API and should be preferred in production

metrics()

auto metrics ( ) const -> const analytics_metrics&

inlinenodiscard

Returns the analytics_metrics as returned by the analytics engine if enabled.

Returns

metrics

Since

1.0.0

Committed

Generally available API and should be preferred in production

request_id()

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

inlinenodiscard

Returns the request identifier string of the query request.

Returns

The request identifier string

Since

1.0.0

Committed

Generally available API and should be preferred in production

signature()

auto signature ( ) const -> const std::optional<codec::binary>&

inlinenodiscard

Returns the signature as returned by the analytics engine.

Returns

optional byte string containing JSON encoded signature

Since

1.0.0

Committed

Generally available API and should be preferred in production

status()

auto status ( ) const -> analytics_status

inlinenodiscard

Returns the raw query execution status as returned by the query engine.

Returns

query execution status

Since

1.0.0

Committed

Generally available API and should be preferred in production

warnings()

auto warnings ( ) const -> const std::vector<analytics_warning>&

inlinenodiscard

Returns any warnings returned by the analytics 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

---

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

• couchbase/analytics_meta_data.hxx