analytics_result Class Reference

Represents result of cluster::analytics_query() and scope::analytics_query() calls. More...

#include <couchbase/analytics_result.hxx>

Public Member Functions
	analytics_result ()=default
	analytics_result (analytics_meta_data meta_data, std::vector< codec::binary > rows)
auto	meta_data () const -> const analytics_meta_data &
	Returns the analytics_meta_data giving access to the additional metadata associated with this analytics query.
auto	rows_as_binary () const -> const std::vector< codec::binary > &
template<typename Serializer = codec::tao_json_serializer, typename Document = typename Serializer::document_type, std::enable_if_t< codec::is_serializer_v< Serializer >, bool > = true>
auto	rows_as () const -> std::vector< Document >

Detailed Description

Represents result of cluster::analytics_query() and scope::analytics_query() calls.

Since

1.0.0

Committed

Generally available API and should be preferred in production

Constructor & Destructor Documentation

analytics_result() [1/2]

analytics_result ( )

default

Since

1.0.0

Internal

Internal interface

analytics_result() [2/2]

analytics_result ( analytics_meta_data meta_data, std::vector< codec::binary > rows )

inline

Since

1.0.0

Volatile

Should not be used in production

Member Function Documentation

meta_data()

auto meta_data ( ) const -> const analytics_meta_data&

inlinenodiscard

Returns the analytics_meta_data giving access to the additional metadata associated with this analytics query.

Returns

response metadata

Since

1.0.0

Committed

Generally available API and should be preferred in production

rows_as()

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

auto rows_as ( ) const -> std::vector<Document>

inlinenodiscard

rows_as_binary()

auto rows_as_binary ( ) const -> const std::vector<codec::binary>&

inlinenodiscard

Returns

list of analytics results as binary strings

Since

1.0.0

Internal

Internal interface

---

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

• couchbase/analytics_result.hxx