| MONGOC_BULK_OPERATION_REPLACE_ONE_WITH_OPTS(3) | libmongoc | MONGOC_BULK_OPERATION_REPLACE_ONE_WITH_OPTS(3) |
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 <https://www.mongoc.org/libbson/current/bson_t.html> that selects which document to remove.
- document: A bson_t <https://www.mongoc.org/libbson/current/bson_t.html> containing the replacement document.
- error: A bson_error_t <https://www.mongoc.org/libbson/current/bson_error_t.html> 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 <https://www.mongoc.org/libbson/current/bson_validate_flags_t.html>. Set to false to skip client-side validation of the provided BSON documents.
- collation: Configure textual comparisons. See Setting Collation Order <https://www.mongodb.com/docs/languages/c/c-driver/current/libmongoc/guides/bulk/#setting-collation-order>, and the MongoDB Manual entry on Collation <https://www.mongodb.com/docs/manual/reference/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.
- upsert: If true, insert a document if none match selector.
- sort: Specify a sort order when matching documents.
Warning:
document may not contain fields with keys
containing . or $.
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.
See also:
mongoc_bulk_operation_remove_many_with_opts() <>
mongoc_bulk_operation_insert() <>
Author¶
MongoDB, Inc
Copyright¶
2009-present, MongoDB, Inc.
| November 26, 2025 | 2.2.0 |