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: A bson_t containing the query to match documents.
  • reply: Optional. An uninitialized bson_t populated with the delete result, or NULL.
  • error: An optional location for a bson_error_t or NULL.

opts may be NULL or a BSON document with additional command options:

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.