mongoc_collection_stats - Man Page

bool
mongoc_collection_stats (mongoc_collection_t *collection,
                         const bson_t *options,
                         bson_t *reply,
                         bson_error_t *error);

• collection: A mongoc_collection_t <>.
• options: An optional bson_t <https://www.mongoc.org/libbson/current/bson_t.html> containing extra options to pass to the collStats command.
• reply: A maybe-NULL pointer to overwritable storage <https://www.mongodb.com/docs/languages/c/c-driver/current/libbson/guides/lifetimes/#overwritable-storage> for a bson_t <https://www.mongoc.org/libbson/current/bson_t.html> to contain the results.
• error: An optional location for a bson_error_t <> or NULL.

Run the collStats command to retrieve statistics about the collection.

The command uses the mongoc_read_prefs_t <> set on collection.

Errors are propagated via the error parameter.

Returns true if successful. Returns false and sets error if there are invalid arguments or a server or network error.

reply is always initialized and must be freed with bson_destroy() <https://www.mongoc.org/libbson/current/bson_destroy.html>.

MongoDB, Inc

2009-present, MongoDB, Inc.