MONGOC_BULK_O..._ONE_WITH_OPTS(3)

📦
version 2.5.6 · 16 versions
, in epel 10

💅 MONGOC_BULK_O..._ONE_WITH_OPTS(3) 💅

okay so this is a page from libmongoc (section 3, manual-page girlies rise) and it's all about mongoc_bulk_operation_replace_one_with_opts — yes the name is long, yes she ate, no we are not abbreviating her 💖

✨ 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 */

🌸 DESCRIPTION 🌸

Replace a single document as part of a bulk operation. Only queues the operation, bestie — that's the whole vibe. Nothing happens yet!! To actually execute it, you call mongoc_bulk_operation_execute(). Queue first, slay later. 🎀

🦋 PARAMETERS 🦋

  • bulk — a mongoc_bulk_operation_t. the main character, obviously 👑
  • selector — a bson_t that selects which document to remove. (yes, that's what it says, no I'm not changing it, the original said remove and so do I 🙈)
  • document — a bson_t containing the replacement document. the glow-up in question 💅
  • error — a bson_error_t for any errors that may have occurred. the receipts holder 😭

🎀 opts — the optional little extras 🎀

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. no vibe check on your BSON, live your truth ✨
  • 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. periodt — old servers get an error, not a pass 🫶
  • hint — a document or string that specifies the index to use to support the query predicate. a lil nudge-nudge-wink-wink to the query planner 💖
  • upsert — if true, insert a document if none match selector. nobody matched? then she makes one. main character energy fr fr 🔥
  • sort — specify a sort order when matching documents. because order matters, always 🦋
⚠️ WARNING: document may not contain fields with keys containing . or $. like literally do not. 💀

😭 ERRORS 😭

Operation errors are propagated via mongoc_bulk_operation_execute(), while argument validation errors are reported by the error argument. so like... two different pipelines for your problems, iykyk 🌈

⭐ RETURNS ⭐

Returns true on success, and false if passed invalid arguments. simple. iconic. no notes 💜

👀 SEE ALSO 👀

  • mongoc_bulk_operation_remove_many_with_opts()
  • mongoc_bulk_operation_insert()

go read those too, bestie, they're literally right there 🧚

🙈 AUTHOR 🙈

MongoDB, Inc — kings of the database, honestly 👑

2009-present, MongoDB, Inc.

okay that's the whole page!! you understood it, I'm so proud of you 🥹🍓

libmongoc ✦ version 2.5.6 ✦ Oct 09, 2026 — mwah, go replace some documents responsibly, ily 💖✨🎀

📦 where this page comes from