Scroll to navigation

MONGOC_COLLECTION_STATS(3) Library Functions Manual MONGOC_COLLECTION_STATS(3)

NAME

mongoc_collection_stats() - Run the collStats command to retrieve statistics about the collection.

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

COLOPHON

This page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.
2016‐10‐12 MongoDB C Driver