MONGOC_COLLECT...MAND_WITH_OPTS(3)

okay so you've landed on the MONGOC_COLLECT...MAND_WITH_OPTS(3) page from libmongoc — yes, the title is doing the most, but the function we're actually hyping is mongoc_collection_read_command_with_opts. She runs read commands, she handles the MongoDB server version logic for you, and she is lowkey iconic. 💅

✨ SYNOPSIS ✨

bool
mongoc_collection_read_command_with_opts (mongoc_collection_t *collection,
                                          const bson_t *command,
                                          const mongoc_read_prefs_t *read_prefs,
                                          const bson_t *opts,
                                          bson_t *reply,
                                          bson_error_t *error);

💅 DESCRIPTION 💅

Execute a command on the server, applying logic that is specific to commands that read, and taking the MongoDB server version into account. Bestie, this is the “make it make sense” wrapper. To send a raw command to the server without any of this logic, use mongoc_collection_command_simple().

Use this function for commands that read such as "count" or "distinct". Those are her lanes. 🎀

Read preferences, read concern, and collation can be overridden by various sources. In a transaction, read concern and write concern are prohibited in opts and the read preference must be primary or NULL. The highest-priority sources for these options are listed first (the original table is now bullets, because we keep the facts and lose the table energy):

• Read Preferences: read_prefs, then Transaction, then collection.
• Read Concern: opts, then Transaction.
• Collation: opts only.

No write concern is applied. Fr fr, none. 🫶

See the example for transactions and for the "distinct" command with opts.

reply is always initialized, and must be freed with bson_destroy(). Don't leave her hanging.

This function is considered a retryable read operation. Upon a transient error (a network error, errors due to replica set failover, etc.) the operation is safely retried once. If retryreads is false in the URI (see mongoc_uri_t) the retry behavior does not apply.

Retry logic occurs regardless of the underlying command. Retrying mapReduce has the potential for degraded performance. Retrying a getMore command has the potential to miss results. For those commands, use generic command helpers (like mongoc_collection_command_with_opts()) instead.

⚠️ okay but seriously: retrying mapReduce can degrade performance, and retrying a getMore can miss results. For those two, use the generic command helpers like mongoc_collection_command_with_opts(). This is not a drill, bestie. 😭

🎀 PARAMETERS 🎀

• collection: A mongoc_collection_t.
• command: A bson_t containing the command specification.
• read_prefs: An optional mongoc_read_prefs_t.
• opts: A bson_t containing additional options.
• reply: A maybe-NULL pointer to overwritable storage for a bson_t to contain the results.
• error: An optional location for a bson_error_t or NULL.

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

• readConcern: Construct a mongoc_read_concern_t and use mongoc_read_concern_append() to add the read concern to opts. See the example code for mongoc_client_read_command_with_opts(). Read concern requires MongoDB 3.2 or later, otherwise an error is returned. ⭐
• sessionId: First, construct a mongoc_client_session_t with mongoc_client_start_session(). You can begin a transaction with mongoc_client_session_start_transaction(), optionally with a mongoc_transaction_opt_t that overrides the options inherited from collection, and use mongoc_client_session_append() to add the session to opts. See the example code for mongoc_client_session_t. 🦋
• 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. 🌸
• serverId: To target a specific server, include an int32 "serverId" field. Obtain the id by calling mongoc_client_select_server(), then mongoc_server_description_id() on its return value. 🎯

Consult the MongoDB Manual entry on Database Commands for each command's arguments. That's where the per-command tea lives. 🍓

😭 ERRORS 😭

Errors are propagated via the error parameter. Simple, clean, no cap.

🫶 RETURNS 🫶

Returns true if successful. Returns false and sets error if there are invalid arguments or a server or network error.

🌈 EXAMPLE 🌈

See the example code for mongoc_client_read_command_with_opts(). Go peek, it's giving exactly what you need. ✨

👑 AUTHOR 👑

MongoDB, Inc

💖 COPYRIGHT 💖

2009-present, MongoDB, Inc.

---

made with 💖 by libmongoc 2.5.6, dated Oct 09, 202… — the footer and the page title are holding hands, and honestly? cute. 🎀