NAME¶

Error_Reporting - Many C Driver functions report errors by returning false or -1 and filling out a bson_error_t structure with an error domain, error code, and message. Use domain to determine which subsystem generated the error, and code for the specific error. message is a human-readable error description.

DESCRIPTION¶

Many C Driver functions report errors by returning false or ‐1 and filling out a bson_error_t structure with an error domain, error code, and message. Use domain to determine which subsystem generated the error, and code for the specific error. message is a human‐readable error description.

See also: Handling Errors in libbson

None: MONGOC_ERROR_CLIENT_TOO_BIG You tried to send a message larger than the server's max message size.
MONGOC_ERROR_CLIENT_AUTHENTICATE: Wrong credentials, or failure sending or receiving authentication messages.
MONGOC_ERROR_CLIENT_NO_ACCEPTABLE_PEER: You tried an SSL connection but the driver was not built with SSL.
MONGOC_ERROR_CLIENT_IN_EXHAUST: You began iterating an exhaust cursor, then tried to begin another operation with the same mongoc_client_t
None: MONGOC_ERROR_STREAM_NAME_RESOLUTION DNS failure.
MONGOC_ERROR_STREAM_SOCKET: Timeout communicating with server, or connection closed.
MONGOC_ERROR_STREAM_CONNECT: Failed to connect to server.
None: MONGOC_ERROR_PROTOCOL_INVALID_REPLY Corrupt response from server.
MONGOC_ERROR_PROTOCOL_BAD_WIRE_VERSION: The server version is too old or too new to communicate with the driver.
None: MONGOC_ERROR_CURSOR_INVALID_CURSOR You passed bad arguments to mongoc_collection_find , or you called mongoc_cursor_next on a completed or failed cursor, or the cursor timed out on the server.
None: MONGOC_ERROR_QUERY_FAILURE Error API Version 1 : Server error from command or query. The server error message is in message
None: MONGOC_ERROR_QUERY_FAILURE Error API Version 2 : Server error from command or query. The server error message is in message
None: A SASL error code. man sasl_errors for a list of codes.
None: MONGOC_ERROR_BSON_INVALID Corrupt server reply, or you called mongoc_collection_create_index with invalid keys, or tried to insert or update with an invalid document.
None: MONGOC_ERROR_NAMESPACE_INVALID You tried to create a collection with an invalid name.
None: MONGOC_ERROR_COMMAND_INVALID_ARG Many functions set this error code when passed bad parameters. Print the error message for details.
MONGOC_ERROR_PROTOCOL_BAD_WIRE_VERSION: You tried to use a command option the server does not support.
None: Error code from server Error API Version 1 : Server error from a command. The server error message is in message
None: Error code from server Error API Version 2 : Server error from a command. The server error message is in message
None: MONGOC_ERROR_COLLECTION_INSERT_FAILED , MONGOC_ERROR_COLLECTION_UPDATE_FAILED , MONGOC_ERROR_COLLECTION_DELETE_FAILED Invalid or empty input to mongoc_collection_insert , mongoc_collection_insert_bulk , mongoc_collection_update , or mongoc_collection_remove
None: Error code from server Error API Version 1 : Server error from mongoc_collection_insert , mongoc_collection_insert_bulk , mongoc_collection_update , or mongoc_collection_remove
None: Error code from server Error API Version 2 : Server error from mongoc_collection_insert , mongoc_collection_insert_bulk , mongoc_collection_update , or mongoc_collection_remove
None: MONGOC_ERROR_GRIDFS_CHUNK_MISSING The GridFS file is missing a document in its chunks collection.
MONGOC_ERROR_GRIDFS_INVALID_FILENAME: You passed a NULL filename to mongoc_gridfs_remove_by_filename
MONGOC_ERROR_GRIDFS_PROTOCOL_ERROR: You called mongoc_gridfs_file_set_id after mongoc_gridfs_file_save
None: MONGOC_ERROR_SCRAM_PROTOCOL_ERROR Failure in SCRAM‐SHA‐1 authentication.
None: MONGOC_ERROR_SERVER_SELECTION_FAILURE No replica set member or mongos is available, or none matches your read preference , or you supplied an invalid mongoc_read_prefs_t
None: Error code from server There was a write concern error or timeout from the server.

SETTING THE ERROR API VERSION¶

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 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 MONGOC_ERROR_SERVER or MONGOC_ERROR_WRITE_CONCERN

mongoc_cursor_error

MONGOC_ERROR_QUERY

MONGOC_ERROR_SERVER

mongoc_client_command

, mongoc_database_command , and other command functions

MONGOC_ERROR_QUERY

MONGOC_ERROR_SERVER

mongoc_collection_count_with_opts

, mongoc_client_get_database_names , and other command helper functions

MONGOC_ERROR_QUERY

MONGOC_ERROR_SERVER

mongoc_collection_insert

mongoc_collection_insert_bulk

mongoc_collection_update

mongoc_collection_remove

MONGOC_ERROR_COMMAND

MONGOC_ERROR_SERVER

mongoc_bulk_operation_execute

MONGOC_ERROR_COMMAND

MONGOC_ERROR_SERVER

Write‐concern timeout

MONGOC_ERROR_WRITE_CONCERN

The Error API Versions are defined with MONGOC_ERROR_API_VERSION_LEGACY and MONGOC_ERROR_API_VERSION_2 mongoc_client_set_error_api or mongoc_client_pool_set_error_api

COLOPHON¶

This page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.

2016‐10‐12

MongoDB C Driver

Source file:	mongoc_errors.3.en.gz (from libmongoc-doc 1.4.2-1)
Source last updated:	2016-10-12T15:12:09Z
Converted to HTML:	2019-06-03T07:33:52Z

NAME¶

DESCRIPTION¶

SETTING THE ERROR API VERSION¶

SEE ALSO¶

COLOPHON¶