couchbase 3.0.0.alpha.5-x86_64-linux → 3.5.1-x86_64-linux

data/ext/couchbase/errors.hxx

@@ -1,691 +0,0 @@
-/* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
-/*
- *     Copyright 2020 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 <system_error>
-
-namespace couchbase::error
-{
-enum class common_errc {
-    /// A timeout occurs and we are confident that the operation could not have succeeded.  This normally would occur because we received
-    /// confident failures from the server, or never managed to successfully dispatch the operation.
-    unambiguous_timeout = 1,
-
-    /// A timeout occurs and we aren't sure if the underlying operation has completed.  This normally occurs because we sent the request to
-    /// the server successfully, but timed out waiting for the response.  Note that idempotent operations should never return this, as they
-    /// do not have ambiguity.
-    ambiguous_timeout,
-
-    /// A request is cancelled and cannot be resolved in a non-ambiguous way. Most likely the request is in-flight on the socket and the
-    /// socket gets closed.
-    request_canceled,
-
-    /// It is unambiguously determined that the error was caused because of invalid arguments from the user.
-    /// Usually only thrown directly when doing request arg validation
-    invalid_argument,
-
-    /// It can be determined from the config unambiguously that a given service is not available. I.e. no query node in the config, or a
-    /// memcached bucket is accessed and views or n1ql queries should be performed
-    service_not_available,
-
-    /// Query: Error range 5xxx
-    /// Analytics: Error range 25xxx
-    /// KV: error code ERR_INTERNAL (0x84)
-    /// Search: HTTP 500
-    internal_server_failure,
-
-    /// Query: Error range 10xxx
-    /// Analytics: Error range 20xxx
-    /// View: HTTP status 401
-    /// KV: error code ERR_ACCESS (0x24), ERR_AUTH_ERROR (0x20), AUTH_STALE (0x1f)
-    /// Search: HTTP status 401, 403
-    authentication_failure,
-
-    /// Analytics: Errors: 23000, 23003
-    /// KV: Error code ERR_TMPFAIL (0x86), ERR_BUSY (0x85) ERR_OUT_OF_MEMORY (0x82), ERR_NOT_INITIALIZED (0x25)
-    temporary_failure,
-
-    /// Query: code 3000
-    /// Analytics: codes 24000
-    parsing_failure,
-
-    /// KV: ERR_EXISTS (0x02) when replace or remove with cas
-    /// Query: code 12009
-    cas_mismatch,
-
-    /// A request is made but the current bucket is not found
-    bucket_not_found,
-
-    /// A management API attempts to target a scope which does not exist.
-    scope_not_found,
-
-    /// A request is made but the current collection (including scope) is not found
-    collection_not_found,
-
-    /// KV: 0x81 (unknown command), 0x83 (not supported)
-    unsupported_operation,
-
-    /// A feature which is not available was used.
-    feature_not_available,
-
-    /// Query: Codes 12004, 12016 (warning: regex ahead!) Codes 5000 AND message contains index .+ not found
-    /// Analytics: Raised When 24047
-    /// Search: Http status code 400 AND text contains “index not found”
-    index_not_found,
-
-    /// Query:
-    /// Note: the uppercase index for 5000 is not a mistake (also only match on exist not exists because there is a typo
-    ///   somewhere in query engine which might either print exist or exists depending on the codepath)
-    /// Code 5000 AND message contains Index .+ already exist
-    /// Code 4300 AND message contains index .+ already exist
-    ///
-    /// Analytics: Raised When 24048
-    index_exists,
-
-    /// Raised when encoding of a user object failed while trying to write it to the cluster
-    encoding_failure,
-
-    /// Raised when decoding of the data into the user object failed
-    decoding_failure,
-};
-
-/// Errors for related to KeyValue service (kv_engine)
-enum class key_value_errc {
-    /// The document requested was not found on the server.
-    /// KV Code 0x01
-    document_not_found = 100,
-
-    /// In get_any_replica, the get_all_replicas returns an empty stream because all the individual errors are dropped (i.e. all returned a
-    /// document_not_found)
-    document_irretrievable,
-
-    /// The document requested was locked.
-    /// KV Code 0x09
-    document_locked,
-
-    /// The value that was sent was too large to store (typically > 20MB)
-    /// KV Code 0x03
-    value_too_large,
-
-    /// An operation which relies on the document not existing fails because the document existed.
-    /// KV Code 0x02
-    document_exists,
-
-    /// The specified durability level is invalid.
-    /// KV Code 0xa0
-    durability_level_not_available,
-
-    /// The specified durability requirements are not currently possible (for example, there are an insufficient number of replicas online).
-    /// KV Code 0xa1
-    durability_impossible,
-
-    /// A sync-write has not completed in the specified time and has an ambiguous result - it may have succeeded or failed, but the final
-    /// result is not yet known.
-    /// A SEQNO OBSERVE operation is performed and the vbucket UUID changes during polling.
-    /// KV Code 0xa3
-    durability_ambiguous,
-
-    /// A durable write is attempted against a key which already has a pending durable write.
-    /// KV Code 0xa2
-    durable_write_in_progress,
-
-    /// The server is currently working to synchronize all replicas for previously performed durable operations (typically occurs after a
-    /// rebalance).
-    /// KV Code 0xa4
-    durable_write_re_commit_in_progress,
-
-    /// The path provided for a sub-document operation was not found.
-    /// KV Code 0xc0
-    path_not_found,
-
-    /// The path provided for a sub-document operation did not match the actual structure of the document.
-    /// KV Code 0xc1
-    path_mismatch,
-
-    /// The path provided for a sub-document operation was not syntactically correct.
-    /// KV Code 0xc2
-    path_invalid,
-
-    /// The path provided for a sub-document operation is too long, or contains too many independent components.
-    /// KV Code 0xc3
-    path_too_big,
-
-    /// The document contains too many levels to parse.
-    /// KV Code 0xc4
-    path_too_deep,
-
-    /// The value provided, if inserted into the document, would cause the document to become too deep for the server to accept.
-    /// KV Code 0xca
-    value_too_deep,
-
-    /// The value provided for a sub-document operation would invalidate the JSON structure of the document if inserted as requested.
-    /// KV Code 0xc5
-    value_invalid,
-
-    /// A sub-document operation is performed on a non-JSON document.
-    /// KV Code 0xc6
-    document_not_json,
-
-    /// The existing number is outside the valid range for arithmetic operations.
-    /// KV Code 0xc7
-    number_too_big,
-
-    /// The delta value specified for an operation is too large.
-    /// KV Code 0xc8
-    delta_invalid,
-
-    /// A sub-document operation which relies on a path not existing encountered a path which exists.
-    /// KV Code 0xc9
-    path_exists,
-
-    /// A macro was used which the server did not understand.
-    /// KV Code: 0xd0
-    xattr_unknown_macro,
-
-    /// A sub-document operation attempts to access multiple xattrs in one operation.
-    /// KV Code: 0xcf
-    xattr_invalid_key_combo,
-
-    /// A sub-document operation attempts to access an unknown virtual attribute.
-    /// KV Code: 0xd1
-    xattr_unknown_virtual_attribute,
-
-    /// A sub-document operation attempts to modify a virtual attribute.
-    /// KV Code: 0xd2
-    xattr_cannot_modify_virtual_attribute,
-};
-
-/// Errors related to Query service (N1QL)
-enum class query_errc {
-    /// Raised When code range 4xxx other than those explicitly covered
-    planning_failure = 200,
-
-    /// Raised When code range 12xxx and 14xxx (other than 12004 and 12016)
-    index_failure,
-
-    /// Raised When codes 4040, 4050, 4060, 4070, 4080, 4090
-    prepared_statement_failure,
-};
-
-/// Errors related to Analytics service (CBAS)
-enum class analytics_errc {
-    /// Error range 24xxx (excluded are specific codes in the errors below)
-    compilation_failure = 300,
-
-    /// Error code 23007
-    job_queue_full,
-
-    /// Error codes 24044, 24045, 24025
-    dataset_not_found,
-
-    /// Error code 24034
-    dataverse_not_found,
-
-    /// Raised When 24040
-    dataset_exists,
-
-    /// Raised When 24039
-    dataverse_exists,
-
-    /// Raised When 24006
-    link_not_found,
-};
-
-/// Errors related to Search service (CBFT)
-enum class search_errc {};
-
-/// Errors related to Views service (CAPI)
-enum class view_errc {
-    /// Http status code 404
-    /// Reason or error contains “not_found”
-    view_not_found = 500,
-
-    /// Raised on the Management APIs only when
-    /// * Getting a design document
-    /// * Dropping a design document
-    /// * And the server returns 404
-    design_document_not_found,
-};
-
-/// Errors related to management service (ns_server)
-enum class management_errc {
-    /// Raised from the collection management API
-    collection_exists = 600,
-
-    /// Raised from the collection management API
-    scope_exists,
-
-    /// Raised from the user management API
-    user_not_found,
-
-    /// Raised from the user management API
-    group_not_found,
-
-    /// Raised from the user management API
-    user_exists,
-
-    /// Raised from the bucket management API
-    bucket_exists,
-
-    /// Raised from the bucket management API
-    bucket_not_flushable,
-};
-
-/// Errors related to networking IO
-enum class network_errc {
-    /// Unable to resolve node address
-    resolve_failure = 1000,
-
-    /// No hosts left to connect
-    no_endpoints_left,
-
-    /// Failed to complete protocol handshake
-    handshake_failure,
-
-    /// Unexpected protocol state or input
-    protocol_error,
-};
-
-namespace detail
-{
-struct common_error_category : std::error_category {
-    [[nodiscard]] const char* name() const noexcept override
-    {
-        return "common";
-    }
-
-    [[nodiscard]] std::string message(int ev) const noexcept override
-    {
-        switch (static_cast<common_errc>(ev)) {
-            case common_errc::unambiguous_timeout:
-                return "unambiguous_timeout";
-            case common_errc::ambiguous_timeout:
-                return "ambiguous_timeout";
-            case common_errc::request_canceled:
-                return "request_canceled";
-            case common_errc::invalid_argument:
-                return "invalid_argument";
-            case common_errc::service_not_available:
-                return "service_not_available";
-            case common_errc::internal_server_failure:
-                return "internal_server_failure";
-            case common_errc::authentication_failure:
-                return "authentication_failure";
-            case common_errc::temporary_failure:
-                return "temporary_failure";
-            case common_errc::parsing_failure:
-                return "parsing_failure";
-            case common_errc::cas_mismatch:
-                return "cas_mismatch";
-            case common_errc::bucket_not_found:
-                return "bucket_not_found";
-            case common_errc::scope_not_found:
-                return "scope_not_found";
-            case common_errc::collection_not_found:
-                return "collection_not_found";
-            case common_errc::unsupported_operation:
-                return "unsupported_operation";
-            case common_errc::feature_not_available:
-                return "feature_not_available";
-            case common_errc::encoding_failure:
-                return "encoding_failure";
-            case common_errc::decoding_failure:
-                return "decoding_failure";
-            case common_errc::index_not_found:
-                return "index_not_found";
-            case common_errc::index_exists:
-                return "index_exists";
-        }
-        return "FIXME: unknown error code common (recompile with newer library)";
-    }
-};
-
-inline const std::error_category&
-get_common_category()
-{
-    static detail::common_error_category instance;
-    return instance;
-}
-
-struct key_value_error_category : std::error_category {
-    [[nodiscard]] const char* name() const noexcept override
-    {
-        return "key_value";
-    }
-
-    [[nodiscard]] std::string message(int ev) const noexcept override
-    {
-        switch (static_cast<key_value_errc>(ev)) {
-            case key_value_errc::document_not_found:
-                return "document_not_found";
-            case key_value_errc::document_irretrievable:
-                return "document_irretrievable";
-            case key_value_errc::document_locked:
-                return "document_locked";
-            case key_value_errc::value_too_large:
-                return "value_too_large";
-            case key_value_errc::document_exists:
-                return "document_exists";
-            case key_value_errc::durability_level_not_available:
-                return "durability_level_not_available";
-            case key_value_errc::durability_impossible:
-                return "durability_impossible";
-            case key_value_errc::durability_ambiguous:
-                return "durability_ambiguous";
-            case key_value_errc::durable_write_in_progress:
-                return "durable_write_in_progress";
-            case key_value_errc::durable_write_re_commit_in_progress:
-                return "durable_write_re_commit_in_progress";
-            case key_value_errc::path_not_found:
-                return "path_not_found";
-            case key_value_errc::path_mismatch:
-                return "path_mismatch";
-            case key_value_errc::path_invalid:
-                return "path_invalid";
-            case key_value_errc::path_too_big:
-                return "path_too_big";
-            case key_value_errc::path_too_deep:
-                return "path_too_deep";
-            case key_value_errc::value_too_deep:
-                return "value_too_deep";
-            case key_value_errc::value_invalid:
-                return "value_invalid";
-            case key_value_errc::document_not_json:
-                return "document_not_json";
-            case key_value_errc::number_too_big:
-                return "number_too_big";
-            case key_value_errc::delta_invalid:
-                return "delta_invalid";
-            case key_value_errc::path_exists:
-                return "path_exists";
-            case key_value_errc::xattr_unknown_macro:
-                return "xattr_unknown_macro";
-            case key_value_errc::xattr_invalid_key_combo:
-                return "xattr_invalid_key_combo";
-            case key_value_errc::xattr_unknown_virtual_attribute:
-                return "xattr_unknown_virtual_attribute";
-            case key_value_errc::xattr_cannot_modify_virtual_attribute:
-                return "xattr_cannot_modify_virtual_attribute";
-        }
-        return "FIXME: unknown error code key_value (recompile with newer library)";
-    }
-};
-inline const std::error_category&
-get_key_value_category()
-{
-    static detail::key_value_error_category instance;
-    return instance;
-}
-
-struct query_error_category : std::error_category {
-    [[nodiscard]] const char* name() const noexcept override
-    {
-        return "query";
-    }
-
-    [[nodiscard]] std::string message(int ev) const noexcept override
-    {
-        switch (static_cast<query_errc>(ev)) {
-            case query_errc::planning_failure:
-                return "planning_failure";
-            case query_errc::index_failure:
-                return "index_failure";
-            case query_errc::prepared_statement_failure:
-                return "prepared_statement_failure";
-        }
-        return "FIXME: unknown error code in query category (recompile with newer library)";
-    }
-};
-
-inline const std::error_category&
-get_query_category()
-{
-    static detail::query_error_category instance;
-    return instance;
-}
-
-struct search_error_category : std::error_category {
-    [[nodiscard]] const char* name() const noexcept override
-    {
-        return "search";
-    }
-
-    [[nodiscard]] std::string message(int) const noexcept override
-    {
-        return "FIXME: unknown error code in search category (recompile with newer library)";
-    }
-};
-
-inline const std::error_category&
-get_search_category()
-{
-    static detail::search_error_category instance;
-    return instance;
-}
-
-struct view_error_category : std::error_category {
-    [[nodiscard]] const char* name() const noexcept override
-    {
-        return "view";
-    }
-
-    [[nodiscard]] std::string message(int ev) const noexcept override
-    {
-        switch (static_cast<view_errc>(ev)) {
-            case view_errc::view_not_found:
-                return "view_not_found";
-            case view_errc::design_document_not_found:
-                return "design_document_not_found";
-        }
-        return "FIXME: unknown error code in view category (recompile with newer library)";
-    }
-};
-
-inline const std::error_category&
-get_view_category()
-{
-    static detail::view_error_category instance;
-    return instance;
-}
-
-struct analytics_error_category : std::error_category {
-    [[nodiscard]] const char* name() const noexcept override
-    {
-        return "analytics";
-    }
-
-    [[nodiscard]] std::string message(int ev) const noexcept override
-    {
-        switch (static_cast<analytics_errc>(ev)) {
-            case analytics_errc::compilation_failure:
-                return "compilation_failure";
-            case analytics_errc::job_queue_full:
-                return "job_queue_full";
-            case analytics_errc::dataset_not_found:
-                return "dataset_not_found";
-            case analytics_errc::dataverse_not_found:
-                return "dataverse_not_found";
-            case analytics_errc::dataset_exists:
-                return "dataset_exists";
-            case analytics_errc::dataverse_exists:
-                return "dataverse_exists";
-            case analytics_errc::link_not_found:
-                return "link_not_found";
-        }
-        return "FIXME: unknown error code in analytics category (recompile with newer library)";
-    }
-};
-
-inline const std::error_category&
-get_analytics_category()
-{
-    static detail::analytics_error_category instance;
-    return instance;
-}
-
-struct management_error_category : std::error_category {
-    [[nodiscard]] const char* name() const noexcept override
-    {
-        return "management";
-    }
-
-    [[nodiscard]] std::string message(int ev) const noexcept override
-    {
-        switch (static_cast<management_errc>(ev)) {
-            case management_errc::collection_exists:
-                return "collection_exists";
-            case management_errc::scope_exists:
-                return "scope_exists";
-            case management_errc::user_not_found:
-                return "user_not_found";
-            case management_errc::group_not_found:
-                return "group_not_found";
-            case management_errc::user_exists:
-                return "user_exists";
-            case management_errc::bucket_exists:
-                return "bucket_exists";
-            case management_errc::bucket_not_flushable:
-                return "bucket_not_flushable";
-        }
-        return "FIXME: unknown error code in management category (recompile with newer library)";
-    }
-};
-
-inline const std::error_category&
-get_management_category()
-{
-    static detail::management_error_category instance;
-    return instance;
-}
-
-struct network_error_category : std::error_category {
-    [[nodiscard]] const char* name() const noexcept override
-    {
-        return "network";
-    }
-
-    [[nodiscard]] std::string message(int ev) const noexcept override
-    {
-        switch (static_cast<network_errc>(ev)) {
-            case network_errc::resolve_failure:
-                return "resolve_failure";
-            case network_errc::no_endpoints_left:
-                return "no_endpoints_left";
-            case network_errc::handshake_failure:
-                return "handshake_failure";
-            case network_errc::protocol_error:
-                return "protocol_error";
-        }
-        return "FIXME: unknown error code in network category (recompile with newer library)";
-    }
-};
-
-inline const std::error_category&
-get_network_category()
-{
-    static detail::network_error_category instance;
-    return instance;
-}
-
-} // namespace detail
-
-} // namespace couchbase::error
-
-namespace std
-{
-template<>
-struct is_error_code_enum<couchbase::error::common_errc> : true_type {
-};
-
-template<>
-struct is_error_code_enum<couchbase::error::key_value_errc> : true_type {
-};
-
-template<>
-struct is_error_code_enum<couchbase::error::query_errc> : true_type {
-};
-
-template<>
-struct is_error_code_enum<couchbase::error::search_errc> : true_type {
-};
-
-template<>
-struct is_error_code_enum<couchbase::error::view_errc> : true_type {
-};
-
-template<>
-struct is_error_code_enum<couchbase::error::analytics_errc> : true_type {
-};
-
-template<>
-struct is_error_code_enum<couchbase::error::management_errc> : true_type {
-};
-
-template<>
-struct is_error_code_enum<couchbase::error::network_errc> : true_type {
-};
-
-inline std::error_code
-make_error_code(couchbase::error::common_errc e)
-{
-    return { static_cast<int>(e), couchbase::error::detail::get_common_category() };
-}
-
-inline std::error_code
-make_error_code(couchbase::error::key_value_errc e)
-{
-    return { static_cast<int>(e), couchbase::error::detail::get_key_value_category() };
-}
-
-inline std::error_code
-make_error_code(couchbase::error::query_errc e)
-{
-    return { static_cast<int>(e), couchbase::error::detail::get_query_category() };
-}
-
-inline std::error_code
-make_error_code(couchbase::error::search_errc e)
-{
-    return { static_cast<int>(e), couchbase::error::detail::get_search_category() };
-}
-
-inline std::error_code
-make_error_code(couchbase::error::view_errc e)
-{
-    return { static_cast<int>(e), couchbase::error::detail::get_view_category() };
-}
-
-inline std::error_code
-make_error_code(couchbase::error::analytics_errc e)
-{
-    return { static_cast<int>(e), couchbase::error::detail::get_analytics_category() };
-}
-
-inline std::error_code
-make_error_code(couchbase::error::management_errc e)
-{
-    return { static_cast<int>(e), couchbase::error::detail::get_management_category() };
-}
-
-inline std::error_code
-make_error_code(couchbase::error::network_errc e)
-{
-    return { static_cast<int>(e), couchbase::error::detail::get_network_category() };
-}
-
-} // namespace std