- MongoDB C Driver 1.13.1 »
- API Reference »
- mongoc_client_t

# mongoc_client_command_with_opts()

## Synopsis

    bool
    mongoc_client_command_with_opts (
       mongoc_client_t *client,
       const char *db_name,
       const bson_t *command,
       const mongoc_read_prefs_t *read_prefs,
       const bson_t *opts,
       bson_t *reply,
       bson_error_t *error);

Execute a command on the server, interpreting `opts` according to the MongoDB server version. To send a raw command to the server without any of this logic, use mongoc_client_command_simple().

Read preferences, read and write concern, and collation can be overridden by various sources. The highest-priority sources for these options are listed first:

Read Preferences | Read Concern | Write Concern | Collation
--- | --- | --- | ---
`read_prefs` | `opts` | `opts` | `opts`
Transaction | Transaction | Transaction |
`client` |  |  |

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.

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

## Parameters

- `client`: A mongoc_client_t.
- `db_name`: The name of the database to run the command on.
- `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 location for the resulting document.
- `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 `client`, 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.

## 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().

Created using Sphinx 1.8.3, based on Sphinx Readable Theme.