mongoc_collection_remove()

Synopsis

bool
mongoc_collection_remove (mongoc_collection_t *collection,
                          mongoc_remove_flags_t flags,
                          const bson_t *selector,
                          const mongoc_write_concern_t *write_concern,
                          bson_error_t *error);

Parameters

• collection: A mongoc_collection_t.

• flags: A mongoc_remove_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

Note

To pass additional options, use mongoc_collection_delete_one() or mongoc_collection_delete_many().

This function shall remove 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.

If you want to limit deletes to a single document, provide MONGOC_REMOVE_SINGLE_REMOVE in flags.

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.