Ubuntu Manpages

ERROR LABELS

« libmongoc

In some cases your application must make decisions based on what category of error the driver has returned, but these categories do not correspond perfectly to an error domain or code. In such cases, error labels provide a reliable way to determine how your application should respond to an error.

Any C Driver function that has a bson_t out-parameter named reply may include error labels to the reply, in the form of a BSON field named "errorLabels" containing an array of strings:

{ "errorLabels": [ "TransientTransactionError" ] }


Use mongoc_error_has_label() to test if a reply contains a specific label. See mongoc_client_session_start_transaction() for example code that demonstrates the use of error labels in application logic.

The following error labels are currently defined. Future versions of MongoDB may introduce new labels.

Within a multi-document transaction, certain errors can leave the transaction in an unknown or aborted state. These include write conflicts, primary stepdowns, and network errors. In response, the application should abort the transaction and try the same sequence of operations again in a new transaction.

When mongoc_client_session_commit_transaction() encounters a network error or certain server errors, it is not known whether the transaction was committed. Applications should attempt to commit the transaction again until: the commit succeeds, the commit fails with an error not labeled "UnknownTransactionCommitResult", or the application chooses to give up.

The driver's error reporting began with a design flaw: when the error domain is MONGOC_ERROR_COLLECTION, MONGOC_ERROR_QUERY, or MONGOC_ERROR_COMMAND, the error code might originate from the server or the driver. An application cannot always know where an error originated, and therefore cannot tell what the code means.

For example, if mongoc_collection_update_one() sets the error's domain to MONGOC_ERROR_COLLECTION and its code to 24, the application cannot know whether 24 is the generic driver error code MONGOC_ERROR_COLLECTION_UPDATE_FAILED or the specific server error code "LockTimeout".

To fix this flaw while preserving backward compatibility, the C Driver 1.4 introduces "Error API Versions". Version 1, the default Error API Version, maintains the flawed behavior. Version 2 adds a new error domain, MONGOC_ERROR_SERVER. In Version 2, error codes originating on the server always have error domain MONGOC_ERROR_SERVER or MONGOC_ERROR_WRITE_CONCERN. When the driver uses Version 2 the application can always determine the origin and meaning of error codes. New applications should use Version 2, and existing applications should be updated to use Version 2 as well.

Error Source API Version 1 API Version 2
mongoc_cursor_error() MONGOC_ERROR_QUERY MONGOC_ERROR_SERVER
mongoc_client_command_with_opts(), mongoc_database_command_with_opts(), and other command functions MONGOC_ERROR_QUERY MONGOC_ERROR_SERVER
mongoc_collection_count_with_opts() mongoc_client_get_database_names_with_opts(), and other command helper functions MONGOC_ERROR_QUERY MONGOC_ERROR_SERVER
mongoc_collection_insert_one() mongoc_collection_insert_bulk() mongoc_collection_update_one() mongoc_collection_update_many() mongoc_collection_replace_one() mongoc_collection_delete_one() mongoc_collection_delete_many() MONGOC_ERROR_COMMAND MONGOC_ERROR_SERVER
mongoc_bulk_operation_execute() MONGOC_ERROR_COMMAND MONGOC_ERROR_SERVER
Write-concern timeout MONGOC_ERROR_WRITE_CONCERN MONGOC_ERROR_WRITE_CONCERN

The Error API Versions are defined with MONGOC_ERROR_API_VERSION_LEGACY and MONGOC_ERROR_API_VERSION_2. Set the version with mongoc_client_set_error_api() or mongoc_client_pool_set_error_api().

SEE ALSO:

MongoDB Server Error Codes



MongoDB, Inc

2017-present, MongoDB, Inc