NAME¶

SYNOPSIS¶

mongoc_cursor_t *
mongoc_client_command (mongoc_client_t           *client,
                       const char                *db_name,
                       mongoc_query_flags_t       flags,
                       uint32_t                   skip,
                       uint32_t                   limit,
                       uint32_t                   batch_size,
                       const bson_t              *query,
                       const bson_t              *fields,
                       const mongoc_read_prefs_t *read_prefs);

This function executes a command on the server using the database and command specification provided.

PARAMETERS¶

client

A mongoc_client_t

db_name

The name of the database to run the command on.

flags

A mongoc_query_flags_t

skip

The number of result documents to skip.

limit

The maximum number of documents to return.

batch_size

The batch size of documents to return from the MongoDB server.

query

A bson_t containing the command specification.

fields

An optional bson_t containing the fields to return in result documents.

read_prefs

An optional mongoc_read_prefs_t MONGOC_READ_PRIMARY

RETURNS¶

The cursor should be freed with mongoc_cursor_destroy(3)

COLOPHON¶