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, noTransactionentry, slay)
π¨ Transaction vibe check, bestie: in a transaction, read concern and write concern are prohibited inopts, and the read preference must beprimaryorNULL. See the example for transactions and for the"distinct"command withoptsβ 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β Amongoc_database_t. The database main character.commandβ Abson_tcontaining the command specification.read_prefsβ An optionalmongoc_read_prefs_t.optsβ Abson_tcontaining additional options.replyβ A maybe-NULL pointer to overwritable storage for abson_tto contain the results.errorβ An optional location for abson_error_torNULL.
opts may be NULL or a BSON document with additional command options:
readConcernβ Construct amongoc_read_concern_tand usemongoc_read_concern_append()to add the read concern toopts. See the example code formongoc_client_read_command_with_opts(). Read concern requires MongoDB 3.2 or later, otherwise an error is returned.writeConcernβ Construct amongoc_write_concern_tand usemongoc_write_concern_append()to add the write concern toopts. See the example code formongoc_client_write_command_with_opts().sessionIdβ First, construct amongoc_client_session_twithmongoc_client_start_session(). You can begin a transaction withmongoc_client_session_start_transaction(), optionally with amongoc_transaction_opt_tthat overrides the options inherited fromdatabase, and usemongoc_client_session_append()to add the session toopts. See the example code formongoc_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 anint32"serverId" field. Obtain the id by callingmongoc_client_select_server(), thenmongoc_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
π¦ COPYRIGHT π¦
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
- epel 10: mongo-c-driver-devel 2.5.6-1.el10_3 Β· Apache-2.0 AND ISC AND MIT AND Zlib
- π girlified by deepseek-ai/DeepSeek-V4.1-Flash-1017 on : a language model's rewrite of the original, under its terms