MONGOC_BULK_OP..._ONE_WITH_OPTS(3)

📦
version 2.5.6 · 16 versions
, in epel 10

okay so you're on the MONGOC_BULK_OP..._ONE_WITH_OPTS(3) page in the libmongoc manual, bestie, and this one is giving “queue up a single delete” energy. Here’s the whole vibe, with every detail kept. 💅

✨ SYNOPSIS ✨

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

Remove a single document as part of a bulk operation. This only queues the operation. To execute it, call mongoc_bulk_operation_execute().

important vibe check: it does not actually run the remove right now — it queues it. The actual execution moment is mongoc_bulk_operation_execute(). 🫶

🌸 PARAMETERS 🌸

  • bulk — A mongoc_bulk_operation_t.
  • selector — A bson_t that selects which document to remove.
  • error — An optional location for a bson_error_t or NULL.

opts may be NULL or a BSON document with additional command options:

  • 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.
  • hint — A document or string that specifies the index to use to support the query predicate.

💀 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_one()
  • mongoc_bulk_operation_remove_many_with_opts()

👑 AUTHOR 👑

MongoDB, Inc

2009-present, MongoDB, Inc.

okay that’s the page, bestie. cute sign-off time: this is version 2.5.6, dated Oct 09, 202 in the footer — and yes, the raw footer has MONGOC_BULK_OP..._ONE_WITH_OPTS(3) crammed right onto it 😭. go queue that single remove with confidence 💖✨

📦 where this page comes from