Ubuntu Manpages

PARAMETERS

  • bulk: A mongoc_bulk_operation_t <>.
  • selector: A bson_t <https://www.mongoc.org/libbson/current/bson_t.html> that selects which documents to remove.
  • document: A bson_t <https://www.mongoc.org/libbson/current/bson_t.html> containing the update 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.
  • arrayFilters: An array of filters specifying to which array elements an update should apply.

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

Returns true on success, and false if there is a server or network error or if passed invalid arguments.

See also:

mongoc_bulk_operation_update_one_with_opts() <>



MongoDB, Inc

2009-present, MongoDB, Inc.