mongoc_collection_delete man page

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

NOTE

This 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.

A write concern timeout or write concern error is considered a failure.

Colophon

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

Info

2016‐11‐07 MongoDB C Driver