mongoc_collection_delete_one()¶
Synopsis¶
bool
mongoc_collection_delete_one (mongoc_collection_t *collection,
const bson_t *selector,
const bson_t *opts,
bson_t *reply,
bson_error_t *error);
Parameters¶
collection: A mongoc_collection_t.selector: Abson_tcontaining the query to match documents.opts: Abson_tcontaining additional options.reply: Optional. An uninitializedbson_tpopulated with the delete result, orNULL.error: An optional location for a bson_error_t orNULL.
opts may be NULL or a BSON document with additional command options:
readConcern: Construct a mongoc_read_concern_t and use mongoc_read_concern_append() to add the read concern toopts. See the example code for mongoc_client_read_command_with_opts().writeConcern: Construct a mongoc_write_concern_t and use mongoc_write_concern_append() to add the write concern toopts. See the example code for mongoc_client_write_command_with_opts().sessionId: Construct a mongoc_client_session_t with mongoc_client_start_session() and use mongoc_client_session_append() to add the session toopts. See the example code for mongoc_client_session_t.validate: Set tofalseto skip client-side validation of the provided BSON documents.bypassDocumentValidation: Set totrueto skip server-side schema validation of the provided BSON documents.collation: Configure textual comparisons. See Setting Collation Order, and the MongoDB Manual entry on Collation.serverId: To target a specific server, include an int32 “serverId” field. Obtain the id by calling mongoc_client_select_server(), then mongoc_server_description_id() on its return value.
Description¶
This function removes at most one document in the given collection that matches selector.
To delete all matching documents, use mongoc_collection_delete_many().
If you pass a non-NULL reply, it is filled out with the field “deletedCount”. If there is a server error then reply contains either a “writeErrors” array with one subdocument or a “writeConcernErrors” array. The reply must be freed with bson_destroy().
Errors¶
Errors are propagated via the error parameter.
Returns¶
Returns true if successful. Returns false and sets error if there are invalid arguments or a server or network error.