couchbase 3.4.1 → 3.4.2

data/ext/couchbase/couchbase/analytics_meta_data.hxx

@@ -0,0 +1,155 @@
+/* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
+/*
+ *   Copyright 2020-Present Couchbase, Inc.
+ *
+ *   Licensed under the Apache License, Version 2.0 (the "License");
+ *   you may not use this file except in compliance with the License.
+ *   You may obtain a copy of the License at
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *   Unless required by applicable law or agreed to in writing, software
+ *   distributed under the License is distributed on an "AS IS" BASIS,
+ *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *   See the License for the specific language governing permissions and
+ *   limitations under the License.
+ */
+
+#pragma once
+
+#include <couchbase/analytics_metrics.hxx>
+#include <couchbase/analytics_status.hxx>
+#include <couchbase/analytics_warning.hxx>
+#include <couchbase/codec/json_transcoder.hxx>
+
+#include <cinttypes>
+#include <optional>
+#include <vector>
+
+namespace couchbase
+{
+
+/**
+ * Stores any non-rows results related to the execution of a particular Analytics query.
+ *
+ * @since 1.0.0
+ * @committed
+ */
+class analytics_meta_data
+{
+  public:
+    /**
+     * @since 1.0.0
+     * @internal
+     */
+    analytics_meta_data() = default;
+
+    /**
+     * @since 1.0.0
+     * @volatile
+     */
+    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)
+      : request_id_{ std::move(request_id) }
+      , client_context_id_{ std::move(client_context_id) }
+      , status_{ status }
+      , warnings_{ std::move(warnings) }
+      , metrics_{ std::move(metrics) }
+      , signature_{ std::move(signature) }
+    {
+    }
+
+    /**
+     * Returns the request identifier string of the query request
+     *
+     * @return The request identifier string
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    [[nodiscard]] auto request_id() const -> const std::string&
+    {
+        return request_id_;
+    }
+
+    /**
+     * Returns the client context identifier string set on the query request.
+     *
+     * @return client context identifier
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    [[nodiscard]] auto client_context_id() const -> const std::string&
+    {
+        return client_context_id_;
+    }
+
+    /**
+     * Returns the raw query execution status as returned by the query engine
+     *
+     * @return query execution status
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    [[nodiscard]] auto status() const -> analytics_status
+    {
+        return status_;
+    }
+
+    /**
+     * Returns any warnings returned by the analytics engine.
+     *
+     * It returns an empty vector if no warnings were returned.
+     *
+     * @return vector of the reported warnings.
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    [[nodiscard]] auto warnings() const -> const std::vector<analytics_warning>&
+    {
+        return warnings_;
+    }
+
+    /**
+     * Returns the {@link analytics_metrics} as returned by the analytics engine if enabled.
+     *
+     * @return metrics
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    [[nodiscard]] auto metrics() const -> const analytics_metrics&
+    {
+        return metrics_;
+    }
+
+    /**
+     * Returns the signature as returned by the analytics engine.
+     *
+     * @return optional byte string containing JSON encoded signature
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    [[nodiscard]] auto signature() const -> const std::optional<codec::binary>&
+    {
+        return signature_;
+    }
+
+  private:
+    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_{};
+};
+
+} // namespace couchbase

data/ext/couchbase/couchbase/analytics_metrics.hxx

@@ -0,0 +1,163 @@
+/* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
+/*
+ *   Copyright 2020-Present Couchbase, Inc.
+ *
+ *   Licensed under the Apache License, Version 2.0 (the "License");
+ *   you may not use this file except in compliance with the License.
+ *   You may obtain a copy of the License at
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *   Unless required by applicable law or agreed to in writing, software
+ *   distributed under the License is distributed on an "AS IS" BASIS,
+ *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *   See the License for the specific language governing permissions and
+ *   limitations under the License.
+ */
+
+#pragma once
+
+#include <chrono>
+#include <cinttypes>
+
+namespace couchbase
+{
+
+/**
+ * Analytics Metrics contains the query result metrics containing counts and timings
+ *
+ * @since 1.0.0
+ * @committed
+ */
+class analytics_metrics
+{
+  public:
+    /**
+     * @since 1.0.0
+     * @internal
+     */
+    analytics_metrics() = default;
+
+    /**
+     * @since 1.0.0
+     * @volatile
+     */
+    analytics_metrics(std::chrono::nanoseconds elapsed_time,
+                      std::chrono::nanoseconds execution_time,
+                      std::uint64_t result_count,
+                      std::uint64_t result_size,
+                      std::uint64_t processed_objects,
+                      std::uint64_t error_count,
+                      std::uint64_t warning_count)
+      : elapsed_time_{ elapsed_time }
+      , execution_time_{ execution_time }
+      , result_count_{ result_count }
+      , result_size_{ result_size }
+      , processed_objects_{ processed_objects }
+      , error_count_{ error_count }
+      , warning_count_{ warning_count }
+    {
+    }
+
+    /**
+     * The total time taken for the request, that is the time from when the request was received until the results were returned.
+     *
+     * @return total time duration
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    [[nodiscard]] auto elapsed_time() const -> std::chrono::nanoseconds
+    {
+        return elapsed_time_;
+    }
+
+    /**
+     * The time taken for the execution of the request, that is the time from when query execution started until the results were returned.
+     *
+     * @return the execution time duration
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    [[nodiscard]] auto execution_time() const -> std::chrono::nanoseconds
+    {
+        return execution_time_;
+    }
+
+    /**
+     * The total number of objects in the results.
+     *
+     * @return number of results
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    [[nodiscard]] auto result_count() const -> std::uint64_t
+    {
+        return result_count_;
+    }
+
+    /**
+     * The total number of bytes in the results
+     *
+     * @return number of bytes
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    [[nodiscard]] auto result_size() const -> std::uint64_t
+    {
+        return result_size_;
+    }
+
+    /**
+     * The number of processed objects for the request.
+     *
+     * @return number of objects
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    [[nodiscard]] auto processed_objects() const -> std::uint64_t
+    {
+        return processed_objects_;
+    }
+
+    /**
+     * The number of errors that occurred during the request
+     *
+     * @return number of errors
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    [[nodiscard]] auto error_count() const -> std::uint64_t
+    {
+        return error_count_;
+    }
+
+    /**
+     * The number of warnings that occurred during the request.
+     *
+     * @return number of warnings
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    [[nodiscard]] auto warning_count() const -> std::uint64_t
+    {
+        return warning_count_;
+    }
+
+  private:
+    std::chrono::nanoseconds elapsed_time_{};
+    std::chrono::nanoseconds execution_time_{};
+    std::uint64_t result_count_{};
+    std::uint64_t result_size_{};
+    std::uint64_t processed_objects_{};
+    std::uint64_t error_count_{};
+    std::uint64_t warning_count_{};
+};
+
+} // namespace couchbase

data/ext/couchbase/couchbase/analytics_options.hxx

@@ -0,0 +1,359 @@
+/* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
+/*
+ *   Copyright 2020-Present Couchbase, Inc.
+ *
+ *   Licensed under the Apache License, Version 2.0 (the "License");
+ *   you may not use this file except in compliance with the License.
+ *   You may obtain a copy of the License at
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *   Unless required by applicable law or agreed to in writing, software
+ *   distributed under the License is distributed on an "AS IS" BASIS,
+ *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *   See the License for the specific language governing permissions and
+ *   limitations under the License.
+ */
+
+#pragma once
+
+#include <couchbase/analytics_error_context.hxx>
+#include <couchbase/analytics_result.hxx>
+#include <couchbase/analytics_scan_consistency.hxx>
+#include <couchbase/codec/tao_json_serializer.hxx>
+#include <couchbase/common_options.hxx>
+#include <couchbase/mutation_state.hxx>
+
+#include <chrono>
+#include <functional>
+#include <memory>
+#include <optional>
+
+namespace couchbase
+{
+/**
+ * Options for cluster#analytics_query() and scope#analytics_query().
+ *
+ * @since 1.0.0
+ * @committed
+ */
+struct analytics_options : public common_options<analytics_options> {
+    /**
+     * Immutable value object representing consistent options.
+     *
+     * @since 1.0.0
+     * @internal
+     */
+    struct built : public common_options<analytics_options>::built {
+        std::optional<std::string> client_context_id;
+        const bool priority;
+        const bool readonly;
+        std::optional<analytics_scan_consistency> scan_consistency;
+        std::optional<std::chrono::milliseconds> scan_wait;
+        std::vector<mutation_token> mutation_state;
+        std::vector<codec::binary> positional_parameters;
+        std::map<std::string, codec::binary, std::less<>> named_parameters;
+        std::map<std::string, codec::binary, std::less<>> raw;
+    };
+
+    /**
+     * Validates options and returns them as an immutable value.
+     *
+     * @return consistent options as an immutable value
+     *
+     * @exception std::system_error with code errc::common::invalid_argument if the options are not valid
+     *
+     * @since 1.0.0
+     * @internal
+     */
+    [[nodiscard]] auto build() const -> built
+    {
+        return {
+            build_common_options(), client_context_id_,     priority_,         readonly_, scan_consistency_, scan_wait_,
+            mutation_state_,        positional_parameters_, named_parameters_, raw_,
+        };
+    }
+
+    /**
+     * Allows to give certain requests higher priority than others.
+     *
+     * @param prioritized if set to true this query will be treated with a higher priority by the service.
+     * @return this options builder for chaining purposes.
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    auto priority(bool prioritized) -> analytics_options&
+    {
+        priority_ = prioritized;
+        return self();
+    }
+
+    /**
+     * Allows explicitly marking a query as being readonly and not mutating and documents on the server side.
+     *
+     * In addition to providing some security in that you are not accidentally modifying data, setting this flag to true also helps the
+     * client to more proactively retry and re-dispatch a query since then it can be sure it is idempotent. As a result, if your query is
+     * readonly then it is a good idea to set this flag.
+     *
+     * @param readonly true if readonly should be set, false is the default and will use the server side default.
+     * @return this options builder for chaining purposes.
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    auto readonly(bool readonly) -> analytics_options&
+    {
+        readonly_ = readonly;
+        return self();
+    }
+
+    /**
+     * Allows customizing how long the query engine is willing to wait until the index catches up to whatever scan
+     * consistency is asked for in this query.
+     *
+     * @note that if {@link analytics_scan_consistency::not_bounded} is used, this method doesn't do anything at all. If no value is
+     * provided to this method, the server default is used.
+     *
+     * @param wait the maximum duration the query engine is willing to wait before failing.
+     * @return this options builder for chaining purposes.
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    auto scan_wait(std::chrono::milliseconds wait) -> analytics_options&
+    {
+        if (scan_consistency_ == analytics_scan_consistency::not_bounded) {
+            scan_wait_.reset();
+        } else {
+            scan_wait_ = wait;
+        }
+        return self();
+    }
+
+    /**
+     * Supports providing a custom client context ID for this query.
+     *
+     * If no client context ID is provided by the user, a UUID is generated and sent automatically so by default it is always possible to
+     * identify a query when debugging.
+     *
+     * @param client_context_id the client context ID
+     * @return this options builder for chaining purposes.
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    auto client_context_id(std::string client_context_id) -> analytics_options&
+    {
+        if (client_context_id.empty()) {
+            client_context_id_.reset();
+        } else {
+            client_context_id_ = std::move(client_context_id);
+        }
+        return self();
+    }
+
+    /**
+     * Customizes the consistency guarantees for this query.
+     *
+     * Tuning the scan consistency allows to trade data "freshness" for latency and vice versa. By default
+     * {@link analytics_scan_consistency::not_bounded} is used, which means that the server returns the data it has in the index right away.
+     * This is fast, but might not include the most recent mutations. If you want to include all the mutations up to the point of the query,
+     * use {@link analytics_scan_consistency::request_plus}.
+     *
+     * Note that you cannot use this method and {@link #consistent_with(const mutation_state&)} at the same time, since they are mutually
+     * exclusive. As a rule of thumb, if you only care to be consistent with the mutation you just wrote on the same thread/app, use
+     * {@link #consistent_with(const mutation_state&)}. If you need "global" scan consistency, use
+     * {@link analytics_scan_consistency::request_plus} on this method.
+     *
+     * @param scan_consistency the index scan consistency to be used for this query
+     * @return this options builder for chaining purposes.
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    auto scan_consistency(analytics_scan_consistency scan_consistency) -> analytics_options&
+    {
+        scan_consistency_ = scan_consistency;
+        mutation_state_.clear();
+        return self();
+    }
+
+    /**
+     * Sets the {@link mutation_token}s this query should be consistent with.
+     *
+     * These mutation tokens are returned from mutations (i.e. as part of a {@link mutation_result}) and if you want your
+     * N1QL query to include those you need to pass the mutation tokens into a {@link mutation_state}.
+     *
+     * Note that you cannot use this method and {@link #scan_consistency(analytics_scan_consistency)} at the same time, since
+     * they are mutually exclusive. As a rule of thumb, if you only care to be consistent with the mutation you just wrote
+     * on the same thread/app, use this method. If you need "global" scan consistency, use
+     * {@link analytics_scan_consistency#request_plus} on {@link #scan_consistency(analytics_scan_consistency)}.
+     *
+     * @param state the mutation state containing the mutation tokens.
+     * @return this options builder for chaining purposes.
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    auto consistent_with(const mutation_state& state) -> analytics_options&
+    {
+        mutation_state_ = state.tokens();
+        scan_consistency_.reset();
+        return self();
+    }
+
+    /**
+     *
+     * @tparam Value
+     * @param name
+     * @param value
+     * @return this options builder for chaining purposes.
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    template<typename Value>
+    auto raw(std::string name, const Value& value) -> analytics_options&
+    {
+        raw_[std::move(name)] = std::move(codec::tao_json_serializer::serialize(value));
+        return self();
+    }
+
+    /**
+     * Set list of positional parameters for a query.
+     *
+     * @tparam Parameters types for the parameters
+     * @param parameters the sequence of positional parameters. Each entry will be encoded into JSON.
+     * @return this options builder for chaining purposes.
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    template<typename... Parameters>
+    auto positional_parameters(const Parameters&... parameters) -> analytics_options&
+    {
+        named_parameters_.clear();
+        positional_parameters_.clear();
+        encode_positional_parameters(parameters...);
+        return self();
+    }
+
+    /**
+     * Set list of named parameters for a query.
+     *
+     * @tparam Parameters types for the parameter pairs
+     * @param parameters the sequence of name-value pairs. Each value will be encoded into JSON.
+     * @return this options builder for chaining purposes.
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    template<typename... Parameters>
+    auto named_parameters(const Parameters&... parameters) -> analytics_options&
+    {
+        named_parameters_.clear();
+        positional_parameters_.clear();
+        encode_named_parameters(parameters...);
+        return self();
+    }
+
+    /**
+     * Set map of raw options for a query.
+     *
+     * This function expects that all parameters encoded into pairs containing mapping names of the parameter to valid JSON values encoded
+     * as string.
+     *
+     * @note This function is low-level, and instead @ref raw() should be considered.
+     *
+     * @param options mapping of pairs, where each entry contains string with valid JSON value.
+     * @return this options builder for chaining purposes.
+     *
+     * @since 1.0.0
+     * @uncommitted
+     */
+    auto encoded_raw_options(std::map<std::string, codec::binary, std::less<>> options) -> analytics_options&
+    {
+        raw_ = std::move(options);
+        return self();
+    }
+
+    /**
+     * Set list of positional parameters for a query.
+     *
+     * This function expects that all parameters encoded into byte strings containing valid JSON values.
+     *
+     * @note This function is low-level, and instead @ref positional_parameters() should be considered.
+     *
+     * @param parameters vector of binaries, where each entry contains string with valid JSON value.
+     * @return this options builder for chaining purposes.
+     *
+     * @since 1.0.0
+     * @uncommitted
+     */
+    auto encoded_positional_parameters(std::vector<codec::binary> parameters) -> analytics_options&
+    {
+        named_parameters_.clear();
+        positional_parameters_ = std::move(parameters);
+        return self();
+    }
+
+    /**
+     * Set map of named parameters for a query.
+     *
+     * This function expects that all parameters encoded into pairs containing mapping names of the parameter to valid JSON values encoded
+     * as string.
+     *
+     * @note This function is low-level, and instead @ref named_parameters() should be considered.
+     *
+     * @param parameters mapping of pairs, where each entry contains string with valid JSON value.
+     * @return this options builder for chaining purposes.
+     *
+     * @since 1.0.0
+     * @uncommitted
+     */
+    auto encoded_named_parameters(std::map<std::string, codec::binary, std::less<>> parameters) -> analytics_options&
+    {
+        named_parameters_ = std::move(parameters);
+        positional_parameters_.clear();
+        return self();
+    }
+
+  private:
+    template<typename Parameter, typename... Rest>
+    void encode_positional_parameters(const Parameter& parameter, Rest... args)
+    {
+        positional_parameters_.emplace_back(std::move(codec::tao_json_serializer::serialize(parameter)));
+        if constexpr (sizeof...(args) > 0) {
+            encode_positional_parameters(args...);
+        }
+    }
+
+    template<typename Name, typename Parameter, typename... Rest>
+    void encode_named_parameters(const std::pair<Name, Parameter>& parameter, Rest... args)
+    {
+        named_parameters_[parameter.first] = std::move(codec::tao_json_serializer::serialize(parameter.second));
+        if constexpr (sizeof...(args) > 0) {
+            encode_named_parameters(args...);
+        }
+    }
+
+    bool priority_{ true };
+    bool readonly_{ false };
+    std::optional<std::string> client_context_id_{};
+    std::optional<std::chrono::milliseconds> scan_wait_{};
+    std::optional<analytics_scan_consistency> scan_consistency_{};
+    std::vector<mutation_token> mutation_state_{};
+    std::vector<codec::binary> positional_parameters_{};
+    std::map<std::string, codec::binary, std::less<>> raw_{};
+    std::map<std::string, codec::binary, std::less<>> named_parameters_{};
+};
+
+/**
+ * The signature for the handler of the @ref cluster#analytics_query() and @ref scope#analytics_query() operations
+ *
+ * @since 1.0.0
+ * @uncommitted
+ */
+using analytics_handler = std::function<void(couchbase::analytics_error_context, analytics_result)>;
+} // namespace couchbase