1MONGOC_COLLECTION_COMMAND(3)       libmongoc      MONGOC_COLLECTION_COMMAND(3)
2
3
4

NAME

6       mongoc_collection_command - mongoc_collection_command()
7

SYNOPSIS

9          mongoc_cursor_t *
10          mongoc_collection_command (mongoc_collection_t *collection,
11                                     mongoc_query_flags_t flags,
12                                     uint32_t skip,
13                                     uint32_t limit,
14                                     uint32_t batch_size,
15                                     const bson_t *command,
16                                     const bson_t *fields,
17                                     const mongoc_read_prefs_t *read_prefs)
18             BSON_GNUC_WARN_UNUSED_RESULT;
19
20       This  function  is superseded by mongoc_collection_command_with_opts(),
21       mongoc_collection_read_command_with_opts(),              mongoc_collec‐
22       tion_write_command_with_opts(),  and  mongoc_collection_read_write_com‐
23       mand_with_opts().
24
25       This function is not considered a retryable read operation.
26

PARAMETERS

28       · collection: A mongoc_collection_t.
29
30       · flags: A mongoc_query_flags_t.
31
32       · skip: A uint32_t with the number of documents to skip or zero.
33
34       · limit: A uint32_t with the max number of documents to return or zero.
35
36       · batch_size: A uint32_t with the number of documents in each batch  or
37         zero. Default is 100.
38
39       · command: A bson_t containing the command to execute.
40
41       · fields:  A  bson_t  containing  the fields to return or NULL. Not all
42         commands support this option.
43
44       · read_prefs: An optional mongoc_read_prefs_t. Otherwise,  the  command
45         uses mode MONGOC_READ_PRIMARY.
46

RETURNS

48       A mongoc_cursor_t.
49
50       The cursor should be freed with mongoc_cursor_destroy().
51

AUTHOR

53       MongoDB, Inc
54

56       2017-present, MongoDB, Inc
57
58
59
60
611.16.2                           Feb 25, 2020     MONGOC_COLLECTION_COMMAND(3)
Impressum