bionic (3) mongoc_collection_command.3.gz

Provided by: libmongoc-doc_1.9.2+dfsg-1build1_all bug

NAME
       mongoc_collection_command - mongoc_collection_command()


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        is        superseded        by        mongoc_collection_command_with_opts(),
       mongoc_collection_read_command_with_opts(),       mongoc_collection_write_command_with_opts(),        and
       mongoc_collection_read_write_command_with_opts().


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. Not all commands support this option.

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


RETURNS
       A mongoc_cursor_t.

       The cursor should be freed with mongoc_cursor_destroy().


AUTHOR
       MongoDB, Inc


       2018, MongoDB, Inc