bool

       MongoDB, Inc

       Do not use this function to call the  basic  write  commands  "insert",  "update",  and  "delete".  Those
       commands  require  special  logic not implemented in mongoc_collection_write_command_with_opts. For basic
       write operations use CRUD functions such as mongoc_collection_insert_one() and the others described in  ‐
       theCRUDtutorial, or use the BulkAPI.

       2009-present, MongoDB, Inc.

1.30.4                                            Jun 08, 2025      MONGOC_COLLECTION_WRITE_COMMAND_WITH_OPTS(3)

       Errors are propagated via the error parameter.

       See the example code for mongoc_client_read_command_with_opts().

       • collection: A mongoc_collection_t.

       • command: A bson_t containing the command specification.

       • opts: A bson_t containing additional options.

       • reply: A maybe-NULL pointer to overwritablestorage 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:

       • 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   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 SettingCollationOrder, and theMongoDBManualentryonCollation. 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 theMongoDBManualentryonDatabaseCommands for each command's arguments.

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

       A write concern timeout or write concern error is considered a failure.

          bool
          mongoc_collection_write_command_with_opts (mongoc_collection_t *collection,
                                                     const bson_t *command,
                                                     const bson_t *opts,
                                                     bson_t *reply,
                                                     bson_error_t *error);

       Execute  a  command on the server, applying logic that is specific to commands that write, and taking the
       MongoDB server version into account. To send a raw command to the server without any of this  logic,  use
       mongoc_collection_command_simple().

       Use this function for commands that write such as "drop" or "createRole" (but not for "insert", "update",
       or  "delete",  see  BasicWriteOperations).  Write  concern and collation can be overridden by various
       sources. In a transaction, read concern and write concern are prohibited in  opts.  The  highest-priority
       sources  for  these  options  are  listed  first in the following table. The write concern is omitted for
       MongoDB before 3.4.
                                            ┌───────────────┬───────────┐
                                            │ Write Concern │ Collation │
                                            ├───────────────┼───────────┤
                                            │ opts          │ opts      │
                                            ├───────────────┼───────────┤
                                            │ Transaction   │           │
                                            ├───────────────┼───────────┤
                                            │ collection    │           │
                                            └───────────────┴───────────┘

       Seetheexamplefortransactions and for the"distinct"commandwithopts.

       reply is always initialized, and must be freed with bson_destroy().