mongoc_collection_stats man page

mongoc_collection_stats — mongoc_collection_stats()

Synopsis

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

Parameters

  • collection: A mongoc_collection_t.
  • options: An optional bson_t containing extra options to pass to the collStats command.
  • reply: An uninitialized bson_t to store the result.
  • error: An optional location for a bson_error_t or NULL.

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

True if successful.

reply is always initialized and must be freed with bson_destroy().

Author

MongoDB, Inc

Info

May 24, 2017 1.6.3 MongoDB C Driver