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

WARNING:

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

SYNOPSIS

12          bool
13          mongoc_collection_stats (mongoc_collection_t *collection,
14                                   const bson_t *options,
15                                   bson_t *reply,
16                                   bson_error_t *error) BSON_GNUC_DEPRECATED;
17

PARAMETERS

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

DESCRIPTION

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

ERRORS

34       Errors are propagated via the error parameter.
35

RETURNS

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

AUTHOR

43       MongoDB, Inc
44

46       2017-present, MongoDB, Inc
47
48
49
50
511.25.1                           Nov 08, 2023       MONGOC_COLLECTION_STATS(3)
Impressum