mongoc_bulk_operation_update_one_with_opts()¶
Synopsis¶
bool
mongoc_bulk_operation_update_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 */
This function queues an update as part of a bulk operation. It will only modify a single document on the MongoDB server. This function does not execute the operation. To execute the entirety of the bulk operation call mongoc_bulk_operation_execute().
Parameters¶
bulk: A mongoc_bulk_operation_t.selector: Abson_tthat selects which document to remove.document: Abson_tcontaining the update document.error: Abson_error_tany errors that may have occurred.
opts may be NULL or a BSON document with additional command options:
validate: Construct a bitwise-or of all desiredbson_validate_flags_t. Set tofalseto 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 matchselector.arrayFilters: An array of filters specifying to which array elements an update should apply.
Warning
document must only contain fields whose key starts with $. See the update document specification for more details.
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 there is a server or network error or if passed invalid arguments.