couchbase 3.5.1 → 3.5.2

data/ext/couchbase/couchbase/key_value_error_context.hxx

@@ -1,229 +0,0 @@
-/* -*- 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/cas.hxx>
-#include <couchbase/error_context.hxx>
-#include <couchbase/key_value_error_map_info.hxx>
-#include <couchbase/key_value_extended_error_info.hxx>
-#include <couchbase/key_value_status_code.hxx>
-
-#include <cstdint>
-#include <optional>
-
-namespace couchbase
-{
-/**
- * The error context returned with key/value operations.
- *
- * @since 1.0.0
- * @committed
- */
-class key_value_error_context : public error_context
-{
-  public:
-    /**
-     * Creates empty error context
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    key_value_error_context() = default;
-
-    /**
-     * Creates and initializes error context with given parameters.
-     *
-     * @param operation_id
-     * @param ec
-     * @param last_dispatched_to
-     * @param last_dispatched_from
-     * @param retry_attempts
-     * @param retry_reasons
-     * @param id
-     * @param bucket
-     * @param scope
-     * @param collection
-     * @param opaque
-     * @param status_code
-     * @param cas
-     * @param error_map_info
-     * @param extended_error_info
-     *
-     * @since 1.0.0
-     * @internal
-     */
-    key_value_error_context(std::string operation_id,
-                            std::error_code ec,
-                            std::optional<std::string> last_dispatched_to,
-                            std::optional<std::string> last_dispatched_from,
-                            std::size_t retry_attempts,
-                            std::set<retry_reason> retry_reasons,
-                            std::string id,
-                            std::string bucket,
-                            std::string scope,
-                            std::string collection,
-                            std::uint32_t opaque,
-                            std::optional<key_value_status_code> status_code,
-                            couchbase::cas cas,
-                            std::optional<key_value_error_map_info> error_map_info,
-                            std::optional<key_value_extended_error_info> extended_error_info)
-      : error_context{ std::move(operation_id), ec, std::move(last_dispatched_to), std::move(last_dispatched_from), retry_attempts,
-                       std::move(retry_reasons) }
-      , id_{ std::move(id) }
-      , bucket_{ std::move(bucket) }
-      , scope_{ std::move(scope) }
-      , collection_{ std::move(collection) }
-      , opaque_{ opaque }
-      , status_code_{ status_code }
-      , cas_{ cas }
-      , error_map_info_{ std::move(error_map_info) }
-      , extended_error_info_{ std::move(extended_error_info) }
-    {
-    }
-
-    /**
-     * Returns identifier (key) of the document referenced in the operation.
-     *
-     * @return document identifier
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    [[nodiscard]] auto id() const -> const std::string&
-    {
-        return id_;
-    }
-
-    /**
-     * Returns name of the bucket.
-     *
-     * @return name of the bucket.
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    [[nodiscard]] auto bucket() const -> const std::string&
-    {
-        return bucket_;
-    }
-
-    /**
-     * Returns name of the scope of the document.
-     *
-     * @return name of the scope.
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    [[nodiscard]] auto scope() const -> const std::string&
-    {
-        return scope_;
-    }
-
-    /**
-     * Returns name of the collection of the document.
-     *
-     * @return collection name
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    [[nodiscard]] auto collection() const -> const std::string&
-    {
-        return collection_;
-    }
-
-    /**
-     * Returns opaque number generated by the SDK and repeated by the server.
-     *
-     * @return opaque number
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    [[nodiscard]] auto opaque() const -> std::uint32_t
-    {
-        return opaque_;
-    }
-
-    /**
-     * Returns status code from the server response.
-     *
-     * @return protocol status code
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    [[nodiscard]] auto status_code() const -> const std::optional<key_value_status_code>&
-    {
-        return status_code_;
-    }
-
-    /**
-     * Returns CAS value associated with the document on the server.
-     *
-     * @return CAS value
-     *
-     * @since 1.0.0
-     * @uncommitted
-     */
-    [[nodiscard]] auto cas() const -> couchbase::cas
-    {
-        return cas_;
-    }
-
-    /**
-     * Returns entry from error map, if it was mapped.
-     *
-     * @return optional error map info
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    [[nodiscard]] auto error_map_info() const -> const std::optional<key_value_error_map_info>&
-    {
-        return error_map_info_;
-    }
-
-    /**
-     * Returns extended error info (if it was rendered in the server response).
-     *
-     * @return optional error info
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    [[nodiscard]] auto extended_error_info() const -> const std::optional<key_value_extended_error_info>&
-    {
-        return extended_error_info_;
-    }
-
-    [[nodiscard]] auto to_json() const -> std::string;
-
-  private:
-    std::string id_{};
-    std::string bucket_{};
-    std::string scope_{};
-    std::string collection_{};
-    std::uint32_t opaque_{};
-    std::optional<key_value_status_code> status_code_{};
-    couchbase::cas cas_{};
-    std::optional<key_value_error_map_info> error_map_info_{};
-    std::optional<key_value_extended_error_info> extended_error_info_{};
-};
-} // namespace couchbase

data/ext/couchbase/couchbase/key_value_error_map_attribute.hxx

@@ -1,136 +0,0 @@
-/* -*- 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
-
-namespace couchbase
-{
-/**
- * This enum defines known attributes, that could be associated with the error code in the error map.
- * Complete list could be found at https://github.com/couchbase/kv_engine/blob/master/docs/ErrorMap.md#error-attributes.
- */
-enum class key_value_error_map_attribute {
-    /**
-     * The operation was successful for those situations where the error code is indicating successful (i.e. subdocument operations
-     * carried out on a deleted document)
-     */
-    success,
-
-    /**
-     * This attribute means that the error is related to a constraint failure regarding the item itself, i.e. the item does not exist,
-     * already exists, or its current value makes the current operation impossible. Retrying the operation when the item's value or
-     * status has changed may succeed.
-     */
-    item_only,
-
-    /**
-     * This attribute means that a user's input was invalid because it violates the semantics of the operation, or exceeds some
-     * predefined limit.
-     */
-    invalid_input,
-
-    /**
-     * The client's cluster map may be outdated and requires updating. The client should obtain a newer configuration.
-     */
-    fetch_config,
-
-    /**
-     * The current connection is no longer valid. The client must reconnect to the server. Note that the presence of other attributes
-     * may indicate an alternate remedy to fixing the connection without a disconnect, but without special remedial action a disconnect
-     * is needed.
-     */
-    conn_state_invalidated,
-
-    /**
-     * The operation failed because the client failed to authenticate or is not authorized to perform this operation. Note that this
-     * error in itself does not mean the connection is invalid, unless conn-state-invalidated is also present.
-     */
-    auth,
-
-    /**
-     * This error code must be handled specially. If it is not handled, the connection must be dropped.
-     */
-    special_handling,
-
-    /**
-     * The operation is not supported, possibly because the of server version, bucket type, or current user.
-     */
-    support,
-
-    /**
-     * This error is transient. Note that this does not mean the error is retriable.
-     */
-    temp,
-
-    /**
-     * This is an internal error in the server.
-     */
-    internal,
-
-    /**
-     * The operation may be retried immediately.
-     */
-    retry_now,
-
-    /**
-     * The operation may be retried after some time.
-     */
-    retry_later,
-
-    /**
-     * The error is related to the subdocument subsystem.
-     */
-    subdoc,
-
-    /**
-     * The error is related to the DCP subsystem.
-     */
-    dcp,
-
-    /**
-     * Use retry specifications from the server.
-     */
-    auto_retry,
-
-    /**
-     * This attribute means that the error is related to operating on a locked document.
-     */
-    item_locked,
-
-    /**
-     * This attribute means that the error is related to operating on a soft-deleted document.
-     */
-    item_deleted,
-
-    /**
-     * The error is related to rate limitation for the client (version 2)
-     */
-    rate_limit,
-
-    /**
-     * The error is related to a system-defined hard limit for resource usage.
-     * Retrying the operation will most likely not succeed unless an action was
-     * taken on the server to resolve the issue (version 2)
-     */
-    system_constraint,
-
-    /**
-     * The client should not retry the operation.
-     */
-    no_retry,
-};
-} // namespace couchbase

data/ext/couchbase/couchbase/key_value_error_map_info.hxx

@@ -1,138 +0,0 @@
-/* -*- 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/key_value_error_map_attribute.hxx>
-
-#include <cstdint>
-#include <set>
-#include <string>
-
-namespace couchbase
-{
-/**
- * Entry of the ErrorMap.
- *
- * The ErrorMap contains mappings from errors to their attributes, negotiated between the client and the server.
- *
- * @since 1.0.0
- * @committed
- */
-class key_value_error_map_info
-{
-  public:
-    /**
-     * Constructs empty error map entry
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    key_value_error_map_info() = default;
-
-    /**
-     * Constructs and initializes error map entry with given parameters.
-     *
-     * @param code
-     * @param name
-     * @param description
-     * @param attributes
-     *
-     * @since 1.0.0
-     * @internal
-     */
-    key_value_error_map_info(std::uint16_t code,
-                             std::string name,
-                             std::string description,
-                             std::set<key_value_error_map_attribute> attributes)
-      : code_{ code }
-      , name_{ std::move(name) }
-      , description_{ std::move(description) }
-      , attributes_{ std::move(attributes) }
-    {
-    }
-
-    /**
-     * Returns numeric error code.
-     *
-     * @return error code
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    [[nodiscard]] auto code() const -> std::uint16_t
-    {
-        return code_;
-    }
-
-    /**
-     * Returns symbolic name of the error code.
-     *
-     * @return error name
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    [[nodiscard]] auto name() const -> const std::string&
-    {
-        return name_;
-    }
-
-    /**
-     * Returns human readable description of the error code.
-     *
-     * @return error description
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    [[nodiscard]] auto description() const -> const std::string&
-    {
-        return description_;
-    }
-
-    /**
-     * Returns set of the attributes associated with error code.
-     *
-     * @return set of the associated attributes
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    [[nodiscard]] auto attributes() const -> const std::set<key_value_error_map_attribute>&
-    {
-        return attributes_;
-    }
-
-    /**
-     * @return true if error map info contains retry attribute
-     *
-     * @since 1.0.0
-     * @internal
-     */
-    [[nodiscard]] bool has_retry_attribute() const
-    {
-        return attributes_.count(key_value_error_map_attribute::retry_now) > 0;
-    }
-
-  private:
-    std::uint16_t code_{};
-    std::string name_{};
-    std::string description_{};
-    std::set<key_value_error_map_attribute> attributes_{};
-};
-} // namespace couchbase

data/ext/couchbase/couchbase/key_value_extended_error_info.hxx

@@ -1,86 +0,0 @@
-/* -*- 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 <string>
-
-namespace couchbase
-{
-/**
- * Represents extended error information returned by the server in some cases.
- *
- * For instance, it might contain unique identifier used by the server in its logs (reference), or detailed explanation of the cause of the
- * error (context).
- *
- * @since 1.0.0
- * @committed
- */
-class key_value_extended_error_info
-{
-  public:
-    /**
-     * Constructs empty error info.
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    key_value_extended_error_info() = default;
-
-    /**
-     * Constructs error info with given reference and context.
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    key_value_extended_error_info(std::string reference, std::string context)
-      : reference_(std::move(reference))
-      , context_(std::move(context))
-    {
-    }
-
-    /**
-     * Returns error reference, that could be used to match the operation in server logs.
-     *
-     * @return error reference, or empty string
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    [[nodiscard]] auto reference() const -> const std::string&
-    {
-        return reference_;
-    }
-
-    /**
-     * Returns error context, human readable message explaining cause of the error condition.
-     *
-     * @return error context, or empty string
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    [[nodiscard]] auto context() const -> const std::string&
-    {
-        return context_;
-    }
-
-  private:
-    std::string reference_{};
-    std::string context_{};
-};
-} // namespace couchbase

data/ext/couchbase/couchbase/key_value_status_code.hxx

@@ -1,109 +0,0 @@
-/* -*- 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 <cstdint>
-
-namespace couchbase
-{
-enum class key_value_status_code : std::uint16_t {
-    success = 0x00,
-    not_found = 0x01,
-    exists = 0x02,
-    too_big = 0x03,
-    invalid = 0x04,
-    not_stored = 0x05,
-    delta_bad_value = 0x06,
-    not_my_vbucket = 0x07,
-    no_bucket = 0x08,
-    dcp_stream_not_found = 0x0a,
-    opaque_no_match = 0x0b,
-    locked = 0x09,
-    not_locked = 0x0e,
-    config_only = 0x0d,
-    auth_stale = 0x1f,
-    auth_error = 0x20,
-    auth_continue = 0x21,
-    range_error = 0x22,
-    rollback = 0x23,
-    no_access = 0x24,
-    not_initialized = 0x25,
-    rate_limited_network_ingress = 0x30,
-    rate_limited_network_egress = 0x31,
-    rate_limited_max_connections = 0x32,
-    rate_limited_max_commands = 0x33,
-    scope_size_limit_exceeded = 0x34,
-    unknown_frame_info = 0x80,
-    unknown_command = 0x81,
-    no_memory = 0x82,
-    not_supported = 0x83,
-    internal = 0x84,
-    busy = 0x85,
-    temporary_failure = 0x86,
-    xattr_invalid = 0x87,
-    unknown_collection = 0x88,
-    no_collections_manifest = 0x89,
-    cannot_apply_collections_manifest = 0x8a,
-    collections_manifest_is_ahead = 0x8b,
-    unknown_scope = 0x8c,
-    dcp_stream_id_invalid = 0x8d,
-    durability_invalid_level = 0xa0,
-    durability_impossible = 0xa1,
-    sync_write_in_progress = 0xa2,
-    sync_write_ambiguous = 0xa3,
-    sync_write_re_commit_in_progress = 0xa4,
-    subdoc_path_not_found = 0xc0,
-    subdoc_path_mismatch = 0xc1,
-    subdoc_path_invalid = 0xc2,
-    subdoc_path_too_big = 0xc3,
-    subdoc_doc_too_deep = 0xc4,
-    subdoc_value_cannot_insert = 0xc5,
-    subdoc_doc_not_json = 0xc6,
-    subdoc_num_range_error = 0xc7,
-    subdoc_delta_invalid = 0xc8,
-    subdoc_path_exists = 0xc9,
-    subdoc_value_too_deep = 0xca,
-    subdoc_invalid_combo = 0xcb,
-    subdoc_multi_path_failure = 0xcc,
-    subdoc_success_deleted = 0xcd,
-    subdoc_xattr_invalid_flag_combo = 0xce,
-    subdoc_xattr_invalid_key_combo = 0xcf,
-    subdoc_xattr_unknown_macro = 0xd0,
-    subdoc_xattr_unknown_vattr = 0xd1,
-    subdoc_xattr_cannot_modify_vattr = 0xd2,
-    subdoc_multi_path_failure_deleted = 0xd3,
-    subdoc_invalid_xattr_order = 0xd4,
-    subdoc_xattr_unknown_vattr_macro = 0xd5,
-    subdoc_can_only_revive_deleted_documents = 0xd6,
-    subdoc_deleted_document_cannot_have_value = 0xd7,
-
-    // occurs during a range scan to indicate that the range scan was cancelled.
-    range_scan_cancelled = 0xa5,
-
-    // occurs during a range scan to indicate that a range scan has more results.
-    range_scan_more = 0xa6,
-
-    // occurs during a range scan to indicate that a range scan has completed.
-    range_scan_complete = 0xa7,
-
-    // occurs during a range scan to indicate that a vb-uuid mismatch has occurred.
-    range_scan_vb_uuid_not_equal = 0xa8,
-
-    unknown = 0xffff,
-};
-} // namespace couchbase