MONGOC_BULK_OPERATION_REPLACE_ONE_WITH_OPTS(3) | MongoDB C Driver | MONGOC_BULK_OPERATION_REPLACE_ONE_WITH_OPTS(3) |
NAME¶
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.
- error: A bson_error_t any errors that may have occurred.
opts may be NULL or a BSON document with additional command options:
- validate: Construct a bitwise-or of all desired bson_validate_flags_t. Set to false to skip client-side validation of the provided BSON documents.
- 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.
- upsert: If true, insert a document if none match selector.
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 if passed invalid arguments.AUTHOR¶
MongoDB, IncCOPYRIGHT¶
2017-present, MongoDB, IncFebruary 23, 2019 | 1.14.0 |