error_codes.hxx

Go to the documentation of this file.

/* -*- 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 <system_error>
 
namespace couchbase
{
#ifndef COUCHBASE_CXX_CLIENT_DOXYGEN
namespace core::impl
{
auto
common_category() noexcept -> const std::error_category&;
 
auto
key_value_category() noexcept -> const std::error_category&;
 
auto
query_category() noexcept -> const std::error_category&;
 
auto
analytics_category() noexcept -> const std::error_category&;
 
auto
search_category() noexcept -> const std::error_category&;
 
auto
view_category() noexcept -> const std::error_category&;
 
auto
management_category() noexcept -> const std::error_category&;
 
auto
field_level_encryption_category() noexcept -> const std::error_category&;
 
auto
network_category() noexcept -> const std::error_category&;
 
auto
streaming_json_lexer_category() noexcept -> const std::error_category&;
 
auto
transaction_category() noexcept -> const std::error_category&;
 
auto
transaction_op_category() noexcept -> const std::error_category&;
 
} // namespace core::impl
#endif
 
namespace errc
{
enum class common {
  request_canceled = 2,

  invalid_argument = 3,

  service_not_available = 4,

  // Query: Error range 5xxx
  // Analytics: Error range 25xxx
  // KV: error code ERR_INTERNAL (0x84)
  // Search: HTTP 500
  internal_server_failure = 5,

  // 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 = 6,

  // Analytics: Errors: 23000, 23003
  // KV: Error code ERR_TMPFAIL (0x86), ERR_BUSY (0x85) ERR_OUT_OF_MEMORY (0x82),
  // ERR_NOT_INITIALIZED (0x25)
  temporary_failure = 7,

  // Query: code 3000
  // Analytics: codes 24000
  parsing_failure = 8,

  // KV: ERR_EXISTS (0x02) when replace or remove with cas
  // Query: code 12009
  cas_mismatch = 9,

  bucket_not_found = 10,

  collection_not_found = 11,

  // KV: 0x81 (unknown command), 0x83 (not supported)
  unsupported_operation = 12,

  ambiguous_timeout = 13,

  unambiguous_timeout = 14,

  feature_not_available = 15,

  scope_not_found = 16,

  // 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 = 17,

  // 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 = 18,

  encoding_failure = 19,

  decoding_failure = 20,

  /*
   * Raised when a service decides that the caller must be rate limited due to exceeding a rate
   * threshold of some sort.
   *
   * * KeyValue
   *   0x30 RateLimitedNetworkIngress -> NetworkIngressRateLimitReached
   *   0x31 RateLimitedNetworkEgress -> NetworkEgressRateLimitReached
   *   0x32 RateLimitedMaxConnections -> MaximumConnectionsReached
   *   0x33 RateLimitedMaxCommands -> RequestRateLimitReached
   *
   * * Cluster Manager (body check tbd)
   *   HTTP 429, Body contains "Limit(s) exceeded [num_concurrent_requests]" ->
   * ConcurrentRequestLimitReached HTTP 429, Body contains "Limit(s) exceeded [ingress]" ->
   * NetworkIngressRateLimitReached HTTP 429, Body contains "Limit(s) exceeded [egress]" ->
   * NetworkEgressRateLimitReached Note: when multiple user limits are exceeded the array would
   * contain all the limits exceeded, as "Limit(s) exceeded [num_concurrent_requests,egress]"
   *
   * * Query
   *   Code 1191, Message E_SERVICE_USER_REQUEST_EXCEEDED -> RequestRateLimitReached
   *   Code 1192, Message E_SERVICE_USER_REQUEST_RATE_EXCEEDED -> ConcurrentRequestLimitReached
   *   Code 1193, Message E_SERVICE_USER_REQUEST_SIZE_EXCEEDED -> NetworkIngressRateLimitReached
   *   Code 1194, Message E_SERVICE_USER_RESULT_SIZE_EXCEEDED -> NetworkEgressRateLimitReached
   *
   * * Search
   *   HTTP 429, {"status": "fail", "error": "num_concurrent_requests, value >= limit"} ->
   * ConcurrentRequestLimitReached HTTP 429, {"status": "fail", "error": "num_queries_per_min, value
   * >= limit"}: -> RequestRateLimitReached HTTP 429, {"status": "fail", "error":
   * "ingress_mib_per_min >= limit"} -> NetworkIngressRateLimitReached HTTP 429, {"status": "fail",
   * "error": "egress_mib_per_min >= limit"} -> NetworkEgressRateLimitReached
   *
   * * Analytics
   *   Not applicable at the moment.
   *
   * * Views
   *   Not applicable.
   */
  rate_limited = 21,

  /*
   * Raised when a service decides that the caller must be limited due to exceeding a quota
   * threshold of some sort.
   *
   * * KeyValue
   *   0x34 ScopeSizeLimitExceeded
   *
   * * Cluster Manager
   *   HTTP 429, Body contains "Maximum number of collections has been reached for scope
   * "<scope_name>""
   *
   * * Query
   *   Code 5000, Body contains "Limit for number of indexes that can be created per scope has been
   * reached. Limit : value"
   *
   * * Search
   *   HTTP 400 (Bad request), {"status": "fail", "error": "rest_create_index: error creating index:
   * {indexName}, err: manager_api: CreateIndex, Prepare failed, err: num_fts_indexes (active +
   * pending) >= limit"}
   * * Analytics
   *   Not applicable at the moment
   *
   * * Views
   *   Not applicable
   */
  quota_limited = 22,
};

enum class key_value {
  // KV Code 0x01
  document_not_found = 101,

  document_irretrievable = 102,

  // KV Code 0x09
  document_locked = 103,

  // KV Code 0x03
  value_too_large = 104,

  // KV Code 0x02
  document_exists = 105,

  // KV Code 0xa0
  durability_level_not_available = 107,

  // KV Code 0xa1
  durability_impossible = 108,

  // KV Code 0xa3
  durability_ambiguous = 109,

  // KV Code 0xa2
  durable_write_in_progress = 110,

  // KV Code 0xa4
  durable_write_re_commit_in_progress = 111,

  // KV Code 0xc0
  path_not_found = 113,

  // KV Code 0xc1
  path_mismatch = 114,

  // KV Code 0xc2
  path_invalid = 115,

  // KV Code 0xc3
  path_too_big = 116,

  // KV Code 0xc4
  path_too_deep = 117,

  // KV Code 0xca
  value_too_deep = 118,

  // KV Code 0xc5
  value_invalid = 119,

  // KV Code 0xc6
  document_not_json = 120,

  // KV Code 0xc7
  number_too_big = 121,

  // KV Code 0xc8
  delta_invalid = 122,

  // KV Code 0xc9
  path_exists = 123,

  // KV Code: 0xd0
  xattr_unknown_macro = 124,

  // KV Code: 0xcf
  xattr_invalid_key_combo = 126,

  // KV Code: 0xd1
  xattr_unknown_virtual_attribute = 127,

  // KV Code: 0xd2
  xattr_cannot_modify_virtual_attribute = 128,

  // KV Code: 0x24
  xattr_no_access = 130,

  // KV Code: 0x0e
  document_not_locked = 131,

  // KV Code: 0xd6
  cannot_revive_living_document = 132,

  // KV Code: 0xa8
  mutation_token_outdated = 133,

  // KV Code: 0xa7
  range_scan_completed = 134,

  document_not_found_on_replica = 135,

  replica_index_out_of_bounds = 136,

  replica_index_currently_unavailable = 137,
};

enum class query {
  // Raised When code range 4xxx other than those explicitly covered
  planning_failure = 201,

  // Raised When code range 12xxx and 14xxx (other than 12004 and 12016)
  index_failure = 202,

  // Raised When codes 4040, 4050, 4060, 4070, 4080, 4090
  prepared_statement_failure = 203,

  // Raised when code 12009 AND message does not contain CAS mismatch
  dml_failure = 204,
};

enum class analytics {
  // Error range 24xxx (excluded are specific codes in the errors below)
  compilation_failure = 301,

  // Error code 23007
  job_queue_full = 302,

  // Error codes 24044, 24045, 24025
  dataset_not_found = 303,

  // Error code 24034
  dataverse_not_found = 304,

  // Raised When 24040
  dataset_exists = 305,

  // Raised When 24039
  dataverse_exists = 306,

  // Raised When 24006
  link_not_found = 307,

  // Raised When 24055
  link_exists = 308,
};

enum class search {
  index_not_ready = 401,

  consistency_mismatch = 402,
};

enum class view {
  // Http status code 404
  // Reason or error contains "not_found"
  view_not_found = 501,

  // Raised on the Management APIs only when
  // * Getting a design document
  // * Dropping a design document
  // * And the server returns 404
  design_document_not_found = 502,
};

enum class management {
  collection_exists = 601,

  scope_exists = 602,

  user_not_found = 603,

  group_not_found = 604,

  bucket_exists = 605,

  user_exists = 606,

  bucket_not_flushable = 607,

  eventing_function_not_found = 608,

  eventing_function_not_deployed = 609,

  eventing_function_compilation_failure = 610,

  eventing_function_identical_keyspace = 611,

  eventing_function_not_bootstrapped = 612,

  eventing_function_deployed = 613,

  eventing_function_paused = 614,
};

enum class field_level_encryption {
  generic_cryptography_failure = 700,

  encryption_failure = 701,

  decryption_failure = 702,

  crypto_key_not_found = 703,

  invalid_crypto_key = 704,

  decrypter_not_found = 705,

  encrypter_not_found = 706,

  invalid_ciphertext = 707,
};

enum class network {
  resolve_failure = 1001,

  no_endpoints_left = 1002,

  handshake_failure = 1003,

  protocol_error = 1004,

  configuration_not_available = 1005,

  cluster_closed = 1006,

  end_of_stream = 1007,

  need_more_data = 1008,

  operation_queue_closed = 1009,

  operation_queue_full = 1010,

  request_already_queued = 1011,

  request_cancelled = 1012,

  bucket_closed = 1013,
};

enum class streaming_json_lexer {
  garbage_trailing = 1101,
  special_expected = 1102,
  special_incomplete = 1103,
  stray_token = 1104,
  missing_token = 1105,
  cannot_insert = 1106,
  escape_outside_string = 1107,
  key_outside_object = 1108,
  string_outside_container = 1109,
  found_null_byte = 1110,
  levels_exceeded = 1111,
  bracket_mismatch = 1112,
  object_key_expected = 1113,
  weird_whitespace = 1114,
  unicode_escape_is_too_short = 1115,
  escape_invalid = 1116,
  trailing_comma = 1117,
  invalid_number = 1118,
  value_expected = 1119,
  percent_bad_hex = 1120,
  json_pointer_bad_path = 1121,
  json_pointer_duplicated_slash = 1122,
  json_pointer_missing_root = 1123,
  not_enough_memory = 1124,
  invalid_codepoint = 1125,
  generic = 1126,
  root_is_not_an_object = 1127,
  root_does_not_match_json_pointer = 1128,
};

enum class transaction {
  failed = 1200,
  expired = 1201,
  failed_post_commit = 1202,
  ambiguous = 1203,
};

enum class transaction_op {
  generic = 1300,
 
  active_transaction_record_entry_not_found = 1301,
  active_transaction_record_full = 1302,
  active_transaction_record_not_found = 1303,
  document_already_in_transaction = 1304,
  document_exists = 1305,
  document_not_found = 1306,
  feature_not_available = 1307,
  transaction_aborted_externally = 1308,
  previous_operation_failed = 1309,
  forward_compatibility_failure = 1310,
  parsing_failure = 1311,
  illegal_state = 1312,
  service_not_available = 1313,
  request_canceled = 1314,
  concurrent_operations_detected_on_same_document = 1315,
  commit_not_permitted = 1316,
  rollback_not_permitted = 1317,
  transaction_already_aborted = 1318,
  transaction_already_committed = 1319,
  document_unretrievable = 1320,

  transaction_op_failed = 1399,
};
 
#ifndef COUCHBASE_CXX_CLIENT_DOXYGEN
inline auto
make_error_code(common e) noexcept -> std::error_code
{
  return { static_cast<int>(e), core::impl::common_category() };
}
 
inline auto
make_error_code(key_value e) -> std::error_code
{
  return { static_cast<int>(e), core::impl::key_value_category() };
}
 
inline auto
make_error_code(query e) -> std::error_code
{
  return { static_cast<int>(e), core::impl::query_category() };
}
 
inline auto
make_error_code(search e) -> std::error_code
{
  return { static_cast<int>(e), core::impl::search_category() };
}
 
inline auto
make_error_code(view e) -> std::error_code
{
  return { static_cast<int>(e), core::impl::view_category() };
}
 
inline auto
make_error_code(analytics e) -> std::error_code
{
  return { static_cast<int>(e), core::impl::analytics_category() };
}
 
inline auto
make_error_code(management e) -> std::error_code
{
  return { static_cast<int>(e), core::impl::management_category() };
}
 
inline auto
make_error_code(network e) -> std::error_code
{
  return { static_cast<int>(e), core::impl::network_category() };
}
 
inline auto
make_error_code(field_level_encryption e) -> std::error_code
{
  return { static_cast<int>(e), core::impl::field_level_encryption_category() };
}
 
inline auto
make_error_code(streaming_json_lexer e) -> std::error_code
{
  return { static_cast<int>(e), core::impl::streaming_json_lexer_category() };
}
 
inline auto
make_error_code(transaction e) -> std::error_code
{
  return { static_cast<int>(e), core::impl::transaction_category() };
}
 
inline auto
make_error_code(transaction_op e) -> std::error_code
{
  return { static_cast<int>(e), core::impl::transaction_op_category() };
}
 
#endif
} // namespace errc
} // namespace couchbase
 
#ifndef COUCHBASE_CXX_CLIENT_DOXYGEN
template<>
struct std::is_error_code_enum<couchbase::errc::common> : std::true_type {
};
 
template<>
struct std::is_error_code_enum<couchbase::errc::key_value> : std::true_type {
};
 
template<>
struct std::is_error_code_enum<couchbase::errc::query> : std::true_type {
};
 
template<>
struct std::is_error_code_enum<couchbase::errc::analytics> : std::true_type {
};
 
template<>
struct std::is_error_code_enum<couchbase::errc::search> : std::true_type {
};
 
template<>
struct std::is_error_code_enum<couchbase::errc::view> : std::true_type {
};
 
template<>
struct std::is_error_code_enum<couchbase::errc::management> : std::true_type {
};
 
template<>
struct std::is_error_code_enum<couchbase::errc::field_level_encryption> : std::true_type {
};
 
template<>
struct std::is_error_code_enum<couchbase::errc::network> : std::true_type {
};
 
template<>
struct std::is_error_code_enum<couchbase::errc::streaming_json_lexer> : std::true_type {
};
 
template<>
struct std::is_error_code_enum<couchbase::errc::transaction> : std::true_type {
};
 
template<>
struct std::is_error_code_enum<couchbase::errc::transaction_op> : std::true_type {
};
 
#endif