couchbase::errc Namespace Reference

Enumerations
enum class	common {   request_canceled = 2 , invalid_argument = 3 , service_not_available = 4 , internal_server_failure = 5 ,   authentication_failure = 6 , temporary_failure = 7 , parsing_failure = 8 , cas_mismatch = 9 ,   bucket_not_found = 10 , collection_not_found = 11 , unsupported_operation = 12 , ambiguous_timeout = 13 ,   unambiguous_timeout = 14 , feature_not_available = 15 , scope_not_found = 16 , index_not_found = 17 ,   index_exists = 18 , encoding_failure = 19 , decoding_failure = 20 , rate_limited = 21 ,   quota_limited = 22 }
	Common errors for all services and modules. More...
enum class	key_value {   document_not_found = 101 , document_irretrievable = 102 , document_locked = 103 , value_too_large = 104 ,   document_exists = 105 , durability_level_not_available = 107 , durability_impossible = 108 , durability_ambiguous = 109 ,   durable_write_in_progress = 110 , durable_write_re_commit_in_progress = 111 , path_not_found = 113 , path_mismatch = 114 ,   path_invalid = 115 , path_too_big = 116 , path_too_deep = 117 , value_too_deep = 118 ,   value_invalid = 119 , document_not_json = 120 , number_too_big = 121 , delta_invalid = 122 ,   path_exists = 123 , xattr_unknown_macro = 124 , xattr_invalid_key_combo = 126 , xattr_unknown_virtual_attribute = 127 ,   xattr_cannot_modify_virtual_attribute = 128 , xattr_no_access = 130 , document_not_locked = 131 , cannot_revive_living_document = 132 ,   mutation_token_outdated = 133 , range_scan_completed = 134 }
	Errors for related to Key/Value service (kv_engine) More...
enum class	query { planning_failure = 201 , index_failure = 202 , prepared_statement_failure = 203 , dml_failure = 204 }
	Errors related to Query service (N1QL) More...
enum class	analytics {   compilation_failure = 301 , job_queue_full = 302 , dataset_not_found = 303 , dataverse_not_found = 304 ,   dataset_exists = 305 , dataverse_exists = 306 , link_not_found = 307 , link_exists = 308 }
	Errors related to Analytics service (CBAS) More...
enum class	search { index_not_ready = 401 , consistency_mismatch = 402 }
	Errors related to Search service (CBFT) More...
enum class	view { view_not_found = 501 , design_document_not_found = 502 }
	Errors related to Views service (CAPI) More...
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 }
	Errors related to management service (ns_server) More...
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 }
	Field-Level Encryption Error Definitions. More...
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 }
	Errors related to networking IO. More...
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 }
	Errors related to streaming JSON parser. More...
enum class	transaction { failed = 1200 , expired = 1201 , failed_post_commit = 1202 , ambiguous = 1203 }
	Errors related to a failed transaction. More...
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 ,   transaction_op_failed = 1399 }
	Errors related to a failed transaction operation. More...

Enumeration Type Documentation

analytics

enum class analytics

strong

Errors related to Analytics service (CBAS)

Since

1.0.0

Committed

Generally available API and should be preferred in production

Enumerator
compilation_failure	The query failed to compile. Since 1.0.0 Committed Generally available API and should be preferred in production
job_queue_full	Indicates the analytics server job queue is full. Since 1.0.0 Committed Generally available API and should be preferred in production
dataset_not_found	The dataset referenced in the query is not found on the server. Since 1.0.0 Committed Generally available API and should be preferred in production
dataverse_not_found	The dataverse referenced in the query is not found on the server. Since 1.0.0 Committed Generally available API and should be preferred in production
dataset_exists	The dataset referenced in the query is found on the server, when it should not be. Since 1.0.0 Committed Generally available API and should be preferred in production
dataverse_exists	The dataverse referenced in the query is found on the server, when it should not be. Since 1.0.0 Committed Generally available API and should be preferred in production
link_not_found	The link referenced in the query is not found on the server. Since 1.0.0 Committed Generally available API and should be preferred in production
link_exists	The link referenced in the query is found on the server, when it should not be. Since 1.0.0 Committed Generally available API and should be preferred in production

common

enum class common

strong

Common errors for all services and modules.

Since

1.0.0

Committed

Generally available API and should be preferred in production

Enumerator
request_canceled	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. Since 1.0.0 Committed Generally available API and should be preferred in production
invalid_argument	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 Since 1.0.0 Committed Generally available API and should be preferred in production
service_not_available	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 Since 1.0.0 Committed Generally available API and should be preferred in production
internal_server_failure	Indicates an operation failed because there has been an internal error in the server. Since 1.0.0 Committed Generally available API and should be preferred in production
authentication_failure	Indicates authentication problems. Since 1.0.0 Committed Generally available API and should be preferred in production
temporary_failure	Returned when the server reports a temporary failure. This is exception is very likely retryable. Since 1.0.0 Committed Generally available API and should be preferred in production
parsing_failure	Indicates an operation failed because parsing of the input returned with an error. Since 1.0.0 Committed Generally available API and should be preferred in production
cas_mismatch	Indicates an optimistic locking failure. The operation failed because the specified compare and swap (CAS) value differs from the document's actual CAS value. This means the document was modified since the original CAS value was acquired. The application should usually respond by fetching a fresh version of the document and repeating the failed operation. Since 1.0.0 Committed Generally available API and should be preferred in production
bucket_not_found	A request is made but the current bucket is not found. Since 1.0.0 Committed Generally available API and should be preferred in production
collection_not_found	A request is made but the current collection (including scope) is not found. Since 1.0.0 Committed Generally available API and should be preferred in production
unsupported_operation	The server indicates that the operation is not supported. Since 1.0.0 Committed Generally available API and should be preferred in production
ambiguous_timeout	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. Since 1.0.0 Committed Generally available API and should be preferred in production
unambiguous_timeout	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. Since 1.0.0 Committed Generally available API and should be preferred in production
feature_not_available	A feature which is not available was used. Since 1.0.0 Committed Generally available API and should be preferred in production
scope_not_found	A management API attempts to target a scope which does not exist. Since 1.0.0 Committed Generally available API and should be preferred in production
index_not_found	The index that was referenced by the operation does not exist on the server. Since 1.0.0 Committed Generally available API and should be preferred in production
index_exists	The index that was referenced by the operation exist on the server when it expected not to. Since 1.0.0 Committed Generally available API and should be preferred in production
encoding_failure	Returned when encoding of a user object failed while trying to write it to the cluster. Since 1.0.0 Committed Generally available API and should be preferred in production
decoding_failure	Returned when decoding of the data into the user object failed. Since 1.0.0 Committed Generally available API and should be preferred in production
rate_limited	This error is raised if the operation failed due to hitting a rate-limit on the server side. Note that this rate-limit might be implicitly configured if you are using Couchbase Capella (for example when using the free tier). See the error context with the exception for further information on the exact cause and check the documentation for potential remedy. Since 1.0.0 Committed Generally available API and should be preferred in production
quota_limited	This error is raised if the operation failed due to hitting a quota-limit on the server side. Note that this quota-limit might be implicitly configured if you are using Couchbase Capella (for example when using the free tier). See the error context with the exception for further information on the exact cause and check the documentation for potential remedy.

field_level_encryption

enum class field_level_encryption

strong

Field-Level Encryption Error Definitions.

Since

1.0.0

Volatile

Should not be used in production

Enumerator
generic_cryptography_failure	Generic cryptography failure. Since 1.0.0 Volatile Should not be used in production
encryption_failure	Raised by CryptoManager encrypt when encryption fails for any reason. Should have one of the other Field-Level Encryption errors as a cause. Since 1.0.0 Volatile Should not be used in production
decryption_failure	Raised by CryptoManager.decrypt() when decryption fails for any reason. Should have one of the other Field-Level Encryption errors as a cause. Since 1.0.0 Volatile Should not be used in production
crypto_key_not_found	Raised when a crypto operation fails because a required key is missing. Since 1.0.0 Volatile Should not be used in production
invalid_crypto_key	Raised by an encrypter or decrypter when the key does not meet expectations (for example, if the key is the wrong size). Since 1.0.0 Volatile Should not be used in production
decrypter_not_found	Raised when a message cannot be decrypted because there is no decrypter registered for the algorithm. Since 1.0.0 Volatile Should not be used in production
encrypter_not_found	Raised when a message cannot be encrypted because there is no encrypter registered under the requested alias. Since 1.0.0 Volatile Should not be used in production
invalid_ciphertext	Raised when decryption fails due to malformed input, integrity check failure, etc. Since 1.0.0 Volatile Should not be used in production

key_value

enum class key_value

strong

Errors for related to Key/Value service (kv_engine)

Since

1.0.0

Committed

Generally available API and should be preferred in production

Enumerator
document_not_found	Indicates an operation failed because the key does not exist. Since 1.0.0 Committed Generally available API and should be preferred in production
document_irretrievable	In collection::get_any_replica, the collection::get_all_replicas returns an empty stream because all the individual errors are dropped (all returned a key_value::document_not_found) Since 1.0.0 Committed Generally available API and should be preferred in production
document_locked	Returned when the server reports a temporary failure that is very likely to be lock-related (like an already locked key or a bad cas used for unlock). See also MB-13087 for an explanation of why this is only likely to be lock-related. Since 1.0.0 Committed Generally available API and should be preferred in production
value_too_large	The value that was sent was too large to store (typically > 20MB) Since 1.0.0 Committed Generally available API and should be preferred in production
document_exists	An operation which relies on the document not existing fails because the document existed. Since 1.0.0 Committed Generally available API and should be preferred in production
durability_level_not_available	The specified durability level is invalid. Since 1.0.0 Committed Generally available API and should be preferred in production
durability_impossible	The specified durability requirements are not currently possible (for example, there are an insufficient number of replicas online). Since 1.0.0 Committed Generally available API and should be preferred in production
durability_ambiguous	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. Since 1.0.0 Committed Generally available API and should be preferred in production
durable_write_in_progress	A durable write is attempted against a key which already has a pending durable write. Since 1.0.0 Committed Generally available API and should be preferred in production
durable_write_re_commit_in_progress	The server is currently working to synchronize all replicas for previously performed durable operations (typically occurs after a rebalance). Since 1.0.0 Committed Generally available API and should be preferred in production
path_not_found	The path provided for a sub-document operation was not found. Since 1.0.0 Committed Generally available API and should be preferred in production
path_mismatch	The path provided for a sub-document operation did not match the actual structure of the document. Since 1.0.0 Committed Generally available API and should be preferred in production
path_invalid	The path provided for a sub-document operation was not syntactically correct. Since 1.0.0 Committed Generally available API and should be preferred in production
path_too_big	The path provided for a sub-document operation is too long, or contains too many independent components. Since 1.0.0 Committed Generally available API and should be preferred in production
path_too_deep	The document contains too many levels to parse. Since 1.0.0 Committed Generally available API and should be preferred in production
value_too_deep	The value provided, if inserted into the document, would cause the document to become too deep for the server to accept. Since 1.0.0 Committed Generally available API and should be preferred in production
value_invalid	The value provided for a sub-document operation would invalidate the JSON structure of the document if inserted as requested. Since 1.0.0 Committed Generally available API and should be preferred in production
document_not_json	A sub-document operation is performed on a non-JSON document. Since 1.0.0 Committed Generally available API and should be preferred in production
number_too_big	The existing number is outside the valid range for arithmetic operations. Since 1.0.0 Committed Generally available API and should be preferred in production
delta_invalid	The delta value specified for an operation is too large. Since 1.0.0 Committed Generally available API and should be preferred in production
path_exists	A sub-document operation which relies on a path not existing encountered a path which exists. Since 1.0.0 Committed Generally available API and should be preferred in production
xattr_unknown_macro	A macro was used which the server did not understand. Since 1.0.0 Committed Generally available API and should be preferred in production
xattr_invalid_key_combo	A sub-document operation attempts to access multiple XATTRs in one operation. Since 1.0.0 Committed Generally available API and should be preferred in production
xattr_unknown_virtual_attribute	A sub-document operation attempts to access an unknown virtual attribute. Since 1.0.0 Committed Generally available API and should be preferred in production
xattr_cannot_modify_virtual_attribute	A sub-document operation attempts to modify a virtual attribute. Since 1.0.0 Committed Generally available API and should be preferred in production
xattr_no_access	The user does not have permission to access the attribute. Occurs when the user attempts to read or write a system attribute (name starts with underscore) but does not have the SystemXattrRead / SystemXattrWrite permission. Since 1.0.0 Committed Generally available API and should be preferred in production
document_not_locked	The document is already locked - generally returned when an unlocking operation is being performed. Since 1.0.0 Committed Generally available API and should be preferred in production
cannot_revive_living_document	Only deleted document could be revived. Since 1.0.0 Committed Generally available API and should be preferred in production
mutation_token_outdated	The provided mutation token is outdated compared to the current state of the server. Since 1.0.0 Uncommitted Might be changed in the future, and eventually promoted to committed
range_scan_completed	Internal Internal interface

management

enum class management

strong

Errors related to management service (ns_server)

Since

1.0.0

Committed

Generally available API and should be preferred in production

Enumerator
collection_exists	Raised from the collection management API.
scope_exists	Raised from the collection management API.
user_not_found	Raised from the user management API.
group_not_found	Raised from the user management API.
bucket_exists	Raised from the bucket management API.
user_exists	Raised from the user management API.
bucket_not_flushable	Raised from the bucket management API.
eventing_function_not_found	Occurs if the function is not found name is "ERR_APP_NOT_FOUND_TS".
eventing_function_not_deployed	Occurs if the function is not deployed, but the action expects it to name is "ERR_APP_NOT_DEPLOYED".
eventing_function_compilation_failure	Occurs when the compilation of the function code failed name is "ERR_HANDLER_COMPILATION".
eventing_function_identical_keyspace	Occurs when source and metadata keyspaces are the same. name is "ERR_SRC_MB_SAME"
eventing_function_not_bootstrapped	Occurs when a function is deployed but not “fully” bootstrapped name is "ERR_APP_NOT_BOOTSTRAPPED".
eventing_function_deployed	Occurs when a function is deployed but the action does not expect it to name is "ERR_APP_NOT_UNDEPLOYED".
eventing_function_paused	Occurs when a function is paused but the action does not expect it to name is "ERR_APP_PAUSED".

network

enum class network

strong

Errors related to networking IO.

Since

1.0.0

Uncommitted

Might be changed in the future, and eventually promoted to committed

Enumerator
resolve_failure	Unable to resolve node address. Since 1.0.0 Uncommitted Might be changed in the future, and eventually promoted to committed
no_endpoints_left	No hosts left to connect. Since 1.0.0 Uncommitted Might be changed in the future, and eventually promoted to committed
handshake_failure	Failed to complete protocol handshake. Since 1.0.0 Uncommitted Might be changed in the future, and eventually promoted to committed
protocol_error	Unexpected protocol state or input. Since 1.0.0 Uncommitted Might be changed in the future, and eventually promoted to committed
configuration_not_available	Configuration is not available for some reason. Since 1.0.0 Uncommitted Might be changed in the future, and eventually promoted to committed
cluster_closed	The cluster object has been explicitly closed, no requests allowed. Since 1.0.0 Uncommitted Might be changed in the future, and eventually promoted to committed
end_of_stream	Since 1.0.0 Uncommitted Might be changed in the future, and eventually promoted to committed
need_more_data	Since 1.0.0 Uncommitted Might be changed in the future, and eventually promoted to committed
operation_queue_closed	Since 1.0.0 Uncommitted Might be changed in the future, and eventually promoted to committed
operation_queue_full	Since 1.0.0 Uncommitted Might be changed in the future, and eventually promoted to committed
request_already_queued	Since 1.0.0 Uncommitted Might be changed in the future, and eventually promoted to committed
request_cancelled	Since 1.0.0 Uncommitted Might be changed in the future, and eventually promoted to committed
bucket_closed	Since 1.0.0 Uncommitted Might be changed in the future, and eventually promoted to committed

query

enum class query

strong

Errors related to Query service (N1QL)

Since

1.0.0

Committed

Generally available API and should be preferred in production

Enumerator
planning_failure	Indicates an operation failed because there has been an issue with the query planner. Since 1.0.0 Committed Generally available API and should be preferred in production
index_failure	Indicates an operation failed because there has been an issue with the query planner or similar. Since 1.0.0 Committed Generally available API and should be preferred in production
prepared_statement_failure	Indicates an operation failed because there has been an issue with query prepared statements. Since 1.0.0 Committed Generally available API and should be preferred in production
dml_failure	This exception is raised when the server fails to execute a DML query. Since 1.0.0 Committed Generally available API and should be preferred in production

search

enum class search

strong

Errors related to Search service (CBFT)

Since

1.0.0

Committed

Generally available API and should be preferred in production

Enumerator
index_not_ready	The index referenced in the query is not ready yet. Since 1.0.0 Uncommitted Might be changed in the future, and eventually promoted to committed
consistency_mismatch	Consistency constraints cannot be accepted by the server. Since 1.0.0 Uncommitted Might be changed in the future, and eventually promoted to committed

streaming_json_lexer

enum class streaming_json_lexer

strong

Errors related to streaming JSON parser.

Since

1.0.0

Uncommitted

Might be changed in the future, and eventually promoted to committed

Enumerator
garbage_trailing
special_expected
special_incomplete
stray_token
missing_token
cannot_insert
escape_outside_string
key_outside_object
string_outside_container
found_null_byte
levels_exceeded
bracket_mismatch
object_key_expected
weird_whitespace
unicode_escape_is_too_short
escape_invalid
trailing_comma
invalid_number
value_expected
percent_bad_hex
json_pointer_bad_path
json_pointer_duplicated_slash
json_pointer_missing_root
not_enough_memory
invalid_codepoint
generic
root_is_not_an_object
root_does_not_match_json_pointer

transaction

enum class transaction

strong

Errors related to a failed transaction.

Since

1.0.0

Uncommitted

Might be changed in the future, and eventually promoted to committed

Enumerator
failed
expired
failed_post_commit
ambiguous

transaction_op

enum class transaction_op

strong

Errors related to a failed transaction operation.

Since

1.0.0

Uncommitted

Might be changed in the future, and eventually promoted to committed

Enumerator
generic	Internal Internal interface
active_transaction_record_entry_not_found
active_transaction_record_full
active_transaction_record_not_found
document_already_in_transaction
document_exists
document_not_found
feature_not_available
transaction_aborted_externally
previous_operation_failed
forward_compatibility_failure
parsing_failure
illegal_state
service_not_available
request_canceled
concurrent_operations_detected_on_same_document
commit_not_permitted
rollback_not_permitted
transaction_already_aborted
transaction_already_committed
transaction_op_failed	Internal Internal interface

view

enum class view

strong

Errors related to Views service (CAPI)

Since

1.0.0

Committed

Generally available API and should be preferred in production

Enumerator
view_not_found	View does not exist on the server. Since 1.0.0 Committed Generally available API and should be preferred in production
design_document_not_found	Design document does not exist on the server. Since 1.0.0 Committed Generally available API and should be preferred in production