mongoc_collection_command man page

mongoc_collection_command() — None

Synopsis

mongoc_cursor_t *
mongoc_collection_command (mongoc_collection_t       *collection,
                           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)
BSON_GNUC_WARN_UNUSED_RESULT;

This function creates a cursor which will execute the command when mongoc_cursor_next is called on it. The collection'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

collection
A mongoc_collection_t
flags
A mongoc_query_flags_t
skip
A uint32_t with the number of documents to skip or zero.
limit
A uint32_t with the max number of documents to return or zero.
batch_size
A uint32_t with the number of documents in each batch or zero. Default is 100.
command
A bson_t containing the command to execute.
fields
A bson_t containing the fields to return or NULL
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_collection_command_simple(3).

2016‐11‐07 MongoDB C Driver