---
name: "mongoc_collection_stats"
section: "3"
platform: "linux"
package: "libmongoc-doc"
version: "1.30.4-1+deb13u3"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/mongoc_collection_stats"
---

# mongoc\_collection\_stats(3)

**WARNING:**

Deprecated since version 1.10.0: 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);
```

## PARAMETERS

- •

  **collection**: A *mongoc\_collection\_t*.

- •

  **options**: An optional *bson\_t* containing extra options to pass to the **collStats** command.

- •

  **reply**: A maybe-**NULL** pointer to *overwritable storage* for a *bson\_t* to contain the results.

- •

  **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

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

## COPYRIGHT

2009-present, MongoDB, Inc.