MONGOC_COLLECTION_WRITE_COMMAND_WITH_OPTS(3)

NAME
mongoc_collection_write_command_with_opts - mongoc_collection_write_command_with_opts()

SYNOPSIS

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 Basic Write Operations). Write concern is applied from opts, or else from collection. The write concern is omitted for MongoDB before 3.2. Collation is applied from opts (see example for). Collation requires MongoDB 3.2 or later, otherwise an error is returned. No read concern or read preferences are applied.

To target a specific server, include an integer "serverId" field in opts with an id obtained first by calling mongoc_client_select_server, then mongoc_server_description_id on its return value.

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

PARAMETERS

•   collection: A mongoc_collection_t.

•   command: A bson_t containing the command specification.

•   opts: A bson_t containing additional options.

•   reply: A location for the resulting document.

•   error: An optional location for a bson_error_t or NULL.

ERRORS

Errors are propagated via the error parameter.

RETURNS

true if successful; otherwise false and error is set.

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

BASIC WRITE OPERATIONS

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_write_command_with_opts and the others described in the CRUD tutorial, or use the Bulk API.

EXAMPLE

See the example code for mongoc_client_read_command_with_opts.

AUTHOR
MongoDB, Inc

COPYRIGHT
2017, MongoDB, Inc