MONGOC_DATABA...MAND_WITH_OPTS(3)

πŸ’… mongoc_database_command_with_opts(3) β€” libmongoc manual page πŸ’…

✨ SYNOPSIS ✨

bool
mongoc_database_command_with_opts (
   mongoc_database_t *database,
   const bson_t *command,
   const mongoc_read_prefs_t *read_prefs,
   const bson_t *opts,
   bson_t *reply,
   bson_error_t *error);

okay so bestie, this one runs a command on the server and interprets opts according to the MongoDB server version. If you want to yeet a raw command at the server without any of this logic, use mongoc_client_command_simple() instead, periodt.

Read preferences, read and write concern, and collation can all be overridden by various sources. Highest-priority sources for these options are listed first β€” like, top of the list wins, no cap:

  • Read Preferences β€” first up: read_prefs; then: Transaction
  • Read Concern β€” first up: opts; then: Transaction
  • Write Concern β€” first up: opts; then: Transaction
  • Collation β€” first up: opts (and that's it, no Transaction entry, slay)
🚨 Transaction vibe check, bestie: in a transaction, read concern and write concern are prohibited in opts, and the read preference must be primary or NULL. See the example for transactions and for the "distinct" command with opts β€” iykyk.

reply is always initialized, and must be freed with bson_destroy(). Not me reminding you to clean up, but also literally clean up. πŸ’…

This function is not considered a retryable read operation. Fr fr.

πŸ’– PARAMETERS πŸ’–

  • database β€” A mongoc_database_t. The database main character.
  • 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.
  • writeConcern β€” Construct a mongoc_write_concern_t and use mongoc_write_concern_append() to add the write concern to opts. See the example code for mongoc_client_write_command_with_opts().
  • 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 database, 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 the homework, bestie. πŸ“š

😭 ERRORS 😭

Errors are propagated via the error parameter.

πŸŽ€ RETURNS πŸŽ€

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

The reply is not parsed for a write concern timeout or write concern error.

🌈 EXAMPLE 🌈

See the example code for mongoc_client_read_command_with_opts().

πŸ‘‘ AUTHOR πŸ‘‘

MongoDB, Inc

2009-present, MongoDB, Inc.


πŸ’– okay that's the whole manual page, bestie β€” source/version is libmongoc 2.5.6, dated Oct 09, 2026. Go forth and command responsibly, mwah πŸ’–

πŸ“¦ where this page comes from