MONGOC_COLLECTION_STATS(3)

📦
version 1.30.13 · 13 versions
, in fedora 43

💅 MONGOC_COLLECTION_STATS(3) — the libmongoc page, but make it cute

okay bestie, sit down, hydrate, because we're talking about mongoc_collection_stats() — a lil function from the libmongoc manual, section 3. yes it's real, yes it's deprecated, and yes we're still gonna learn it because context is a love language 💖

⚠️ WARNING — this one is deprecated since version 1.10.0. the glow-up replacement is the $collStats aggregation pipeline stage, used with mongoc_collection_aggregate(). so like… use that instead, fr fr. 💀

✨ SYNOPSIS ✨

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

that's the whole vibe. four arguments, one bool coming back at you. 🫶

🎀 PARAMETERS 🎀

  • collection — a mongoc_collection_t. your main character. the collection we're snooping on. 👑
  • options — an optional bson_t holding extra options you wanna pass along to the collStats command. optional optional, no pressure, she's flexible. ✨
  • reply — a maybe-NULL pointer to overwritable storage for a bson_t that'll contain the results. "maybe-NULL" — so if you pass NULL, that's a choice you're allowed to make, but bestie… 🥴
  • error — an optional place to put a bson_error_t, or NULL. also optional. we love a low-stakes parameter list. 💜

🌸 DESCRIPTION 🌸

she runs the collStats command and retrieves statistics about the collection. that's the whole job. no cap. 📊

and the tea ☕: the command uses the mongoc_read_prefs_t that's set on collection. so whatever read prefs you gave her, that's what she rides with. not a surprise, just how it is. 🌈

💀 ERRORS 💀

errors get propagated via the error parameter. that's it, that's the section. short and iconic. periodt. ✨

🔥 RETURNS 🔥

  • returns true if it worked. slay. 🎉
  • returns false and sets error if there are invalid arguments, or if there's a server error, or a network error. so many ways to have a bad day 😭
🫶 IMPORTANT ONE: reply is always initialized and must be freed with bson_destroy(). always. even if things went sideways. don't leave her hanging, that's a leak and leaks are not cute. 💅

🧚 AUTHOR 🧚

MongoDB, Inc

2009-present, MongoDB, Inc.

okay that's the whole page, you ate that, you're basically a database girlie now 💖 go forth and (please) use $collStats with mongoc_collection_aggregate() instead, because this function is deprecated and we don't stan deprecated APIs in this house 🎀🦋

this has been the libmongoc MONGOC_COLLECTION_STATS(3) page, version 1.30.13, dated Oct 09, 2026 — mwah, bye bestie! 🌸💜🍓

📦 where this page comes from