1MONGOC_COLLECTION_STATS(3)         libmongoc        MONGOC_COLLECTION_STATS(3)
2
3
4

NAME

6       mongoc_collection_stats - mongoc_collection_stats()
7

SYNOPSIS

9          bool
10          mongoc_collection_stats (mongoc_collection_t *collection,
11                                   const bson_t *options,
12                                   bson_t *reply,
13                                   bson_error_t *error) BSON_GNUC_DEPRECATED;
14

DEPRECATED

16       This  helper function is deprecated and should not be used in new code.
17       Run  the  collStats  command  directly   with   mongoc_client_read_com‐
18       mand_with_opts() instead.
19

PARAMETERS

21       • collection: A mongoc_collection_t.
22
23       • options:  An  optional bson_t containing extra options to pass to the
24         collStats command.
25
26       • reply: An uninitialized bson_t to store the result.
27
28       • error: An optional location for a bson_error_t or NULL.
29

DESCRIPTION

31       Run the collStats command to retrieve statistics about the collection.
32
33       The command uses the mongoc_read_prefs_t set on collection.
34

ERRORS

36       Errors are propagated via the error parameter.
37

RETURNS

39       Returns true if successful. Returns false and sets error if  there  are
40       invalid arguments or a server or network error.
41
42       reply is always initialized and must be freed with bson_destroy().
43

AUTHOR

45       MongoDB, Inc
46

48       2017-present, MongoDB, Inc
49
50
51
52
531.21.1                           Mar 02, 2022       MONGOC_COLLECTION_STATS(3)
Impressum