mongoc_database_command man page

mongoc_database_command() — None

Synopsis

mongoc_cursor_t *
mongoc_database_command (mongoc_database_t         *database,
                         mongoc_query_flags_t       flags,
                         uint32_t                   skip,
                         uint32_t                   limit,
                         uint32_t                   batch_size,
                         const bson_t              *command,
                         const bson_t              *fields,
                         const mongoc_read_prefs_t *read_prefs);

This function creates a cursor which will execute the command when mongoc_cursor_next is called on it. The database's read preference, read concern, and write concern are not applied to the command, and mongoc_cursor_next will not check the server response for a write concern error or write concern timeout.

Parameters

database
A mongoc_database_t
flags
A mongoc_query_flags_t
skip
The number of documents to skip on the server.
limit
The maximum number of documents to return from the cursor.
batch_size
Attempt to batch results from the server in groups of batch_size documents.
command
A bson_t containing the command.
fields
An optional bson_t containing the fields to return. NULL for all fields.
read_prefs
An optional mongoc_read_prefs_t MONGOC_READ_PRIMARY

Returns

A mongoc_cursor_t

The cursor should be freed with mongoc_cursor_destroy(3)

Colophon

This page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.

Referenced By

mongoc_database_command_simple(3).

2016‐11‐07 MongoDB C Driver