mongoc_collection_stats - Man Page

Name

mongoc_collection_stats ā€” mongoc_collection_stats()

WARNING:

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

Synopsis

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

Parameters

Description

Run the collStats command to retrieve statistics about the collection.

The command uses the mongoc_read_prefs_t set on collection.

Errors

Errors are propagated via the error parameter.

Returns

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().

Author

MongoDB, Inc

Info

Sep 06, 2023 1.24.4 libmongoc