mongoc_bulk_operation_remove_one_with_opts()#

Synopsis#

bool
mongoc_bulk_operation_remove_one_with_opts (mongoc_bulk_operation_t *bulk,
                                            const bson_t *selector,
                                            const bson_t *opts,
                                            bson_error_t *error); /* OUT */

Remove a single document as part of a bulk operation. This only queues the operation. To execute it, call mongoc_bulk_operation_execute().

Parameters#

bulk: A mongoc_bulk_operation_t.
selector: A bson_t that selects which document to remove.
error: An optional location for a bson_error_t or NULL.

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

collation: Configure textual comparisons. See Setting Collation Order, and the MongoDB Manual entry on Collation. Collation requires MongoDB 3.2 or later, otherwise an error is returned.
hint: A document or string that specifies the index to use to support the query predicate.

Errors#

Operation errors are propagated via mongoc_bulk_operation_execute(), while argument validation errors are reported by the error argument.

Returns#

Returns true on success, and false if passed invalid arguments.