mongoc_database_command_simple()

Synopsis

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

Parameters

• database: A mongoc_database_t.

• command: A bson_t containing the command.

• read_prefs: An optional mongoc_read_prefs_t. Otherwise, the command uses mode MONGOC_READ_PRIMARY.

• 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.

This is a simplified interface to mongoc_database_command() that returns the first result document. The database’s read preference, read concern, and write concern are not applied to the command. The parameter reply is initialized even upon failure to simplify memory management.

This function is not considered a retryable read operation.

Errors

Errors are propagated through the error parameter.

Returns

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

This function does not check the server response for a write concern error or write concern timeout.