table of contents
MONGOC_COLLECTION_DELETE(3) | Library Functions Manual | MONGOC_COLLECTION_DELETE(3) |
NAME¶
mongoc_collection_delete() - This function shall delete documents in the given collection that match selector. The bson selector is not validated, simply passed along as appropriate to the server. As such, compatibility and errors should be validated in the appropriate server documentation.SYNOPSIS¶
bool mongoc_collection_delete (mongoc_collection_t *collection, mongoc_delete_flags_t flags, const bson_t *selector, const mongoc_write_concern_t *write_concern, bson_error_t *error);
DEPRECATED¶
NOTEThis function is deprecated and should not be used in new
code.
Please use mongoc_collection_remove(3) instead.
PARAMETERS¶
- collection
- A mongoc_collection_t
- flags
- A mongoc_delete_flags_t
- selector
- A bson_t containing the query to match documents.
- write_concern
- A mongoc_write_concern_t or NULL
- error
- An optional location for a bson_error_t or NULL
DESCRIPTION¶
This function shall delete documents in the given collection that match selector selector is not validated, simply passed along as appropriate to the server. As such, compatibility and errors should be validated in the appropriate server documentation.If you want to limit deletes to a single document, provide MONGOC_DELETE_SINGLE_REMOVE in flags
ERRORS¶
Errors are propagated via the error parameter.RETURNS¶
true if successful, otherwise false and error is set.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 |