Couchbase C++ SDK 1.0.1 (rev. 58d46d7)
Loading...
Searching...
No Matches
analytics_result.hxx
Go to the documentation of this file.
1/* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
2/*
3 * Copyright 2020-Present Couchbase, Inc.
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18#pragma once
19
22
23#include <chrono>
24#include <cinttypes>
25#include <optional>
26#include <vector>
27
28namespace couchbase
29{
30
38{
39public:
44 analytics_result() = default;
45
50 analytics_result(analytics_meta_data meta_data, std::vector<codec::binary> rows)
51 : meta_data_{ std::move(meta_data) }
52 , rows_{ std::move(rows) }
53 {
54 }
55
65 [[nodiscard]] auto meta_data() const -> const analytics_meta_data&
66 {
67 return meta_data_;
68 }
69
76 [[nodiscard]] auto rows_as_binary() const -> const std::vector<codec::binary>&
77 {
78 return rows_;
79 }
80
81 template<typename Serializer,
82 typename Document = typename Serializer::document_type,
83 std::enable_if_t<codec::is_serializer_v<Serializer>, bool> = true>
84 [[nodiscard]] auto rows_as() const -> std::vector<Document>
85 {
86 std::vector<Document> rows;
87 rows.reserve(rows_.size());
88 for (const auto& row : rows_) {
89 rows.emplace_back(Serializer::template deserialize<Document>(row));
90 }
91 return rows;
92 }
93
94 [[nodiscard]] auto rows_as_json() const -> std::vector<codec::tao_json_serializer::document_type>
95 {
96 return rows_as<codec::tao_json_serializer>();
97 }
98
99private:
100 analytics_meta_data meta_data_{};
101 std::vector<codec::binary> rows_{};
102};
103} // namespace couchbase
Stores any non-rows results related to the execution of a particular Analytics query.
Definition analytics_meta_data.hxx:39
Represents result of cluster::analytics_query() and scope::analytics_query() calls.
Definition analytics_result.hxx:38
auto rows_as_binary() const -> const std::vector< codec::binary > &
Definition analytics_result.hxx:76
analytics_result(analytics_meta_data meta_data, std::vector< codec::binary > rows)
Definition analytics_result.hxx:50
auto meta_data() const -> const analytics_meta_data &
Returns the analytics_meta_data giving access to the additional metadata associated with this analyti...
Definition analytics_result.hxx:65
auto rows_as() const -> std::vector< Document >
Definition analytics_result.hxx:84
auto rows_as_json() const -> std::vector< codec::tao_json_serializer::document_type >
Definition analytics_result.hxx:94
Represents a single item from the result of collection::scan()
Definition allow_querying_search_index_options.hxx:28