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

NAME

6       mongoc_collection_stats - mongoc_collection_stats()
7
8       WARNING:
9          Deprecated  since version 1.10.0: This helper function is deprecated
10          and should not be used in new code. Use the  $collStats  aggregation
11          pipeline stage with mongoc_collection_aggregate() instead.
12
13

SYNOPSIS

15          bool
16          mongoc_collection_stats (mongoc_collection_t *collection,
17                                   const bson_t *options,
18                                   bson_t *reply,
19                                   bson_error_t *error) BSON_GNUC_DEPRECATED;
20

PARAMETERS

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

DESCRIPTION

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

ERRORS

37       Errors are propagated via the error parameter.
38

RETURNS

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

AUTHOR

46       MongoDB, Inc
47

49       2017-present, MongoDB, Inc
50
51
52
53
541.24.3                           Aug 17, 2023       MONGOC_COLLECTION_STATS(3)
Impressum