Ubuntu Manpages

PARAMETERS

  • client: A mongoc_client_t <>.
  • db_name: The name of the database to run the command on.
  • command: A bson_t <https://www.mongoc.org/libbson/current/bson_t.html> containing the command specification.
  • read_prefs: Ignored.
  • opts: A bson_t <https://www.mongoc.org/libbson/current/bson_t.html> containing additional options.
  • reply: A maybe-NULL pointer to overwritable storage <https://www.mongoc.org/libbson/current/lifetimes.html> for a bson_t <https://www.mongoc.org/libbson/current/bson_t.html> 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:

  • 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 <https://www.mongodb.com/docs/languages/c/c-driver/current/libmongoc/guides/bulk/#setting-collation-order>, and the MongoDB Manual entry on Collation <https://www.mongodb.com/docs/manual/reference/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 <https://www.mongodb.com/docs/manual/reference/command/> for each command's arguments.

Errors are propagated via the error parameter.

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.

See the example code for mongoc_client_read_command_with_opts() <>.

MongoDB, Inc

2009-present, MongoDB, Inc.