mongoc_bulk_operation_replace_one_with_opts man page

mongoc_bulk_operation_replace_one_with_opts — mongoc_bulk_operation_replace_one_with_opts()

Synopsis

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

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

  • document: A bson_t containing the replacement document.

  • opts: A bson_t containing additional options.

  • error: A bson_error_t any errors that may have occurred.

WARNING:

document may not contain fields with keys containing . or $.

See Also

mongoc_bulk_operation_remove_many_with_opts()

mongoc_bulk_operation_insert()

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

Author

MongoDB, Inc

Info

Mar 08, 2017 1.6.1 MongoDB C Driver