MONGOC_COLLECT...O_INDEX_STRING(3)

📦
version 2.5.6 · 16 versions
, in epel 10

💖 MONGOC_COLLECT...O_INDEX_STRING(3) 💖

okay so this one is from the libmongoc manual, bestie — and it's all about making index key specs spit out their canonical string form. very main character of it ✨

✨ SYNOPSIS ✨

char *
mongoc_collection_keys_to_index_string (const bson_t *keys);

🎀 PARAMETERS 🎀

  • keys — a bson_t. This is expected to match the form of the key field in the createIndexes command.

🦋 DESCRIPTION 🦋

This function returns the canonical stringification of a given key specification. See Manage Collection Indexes for example usage.

It is a programming error to call this function on a non-standard index — like one other than a straight index with ascending and descending. Not a slay, don't do it 💀

🌸 RETURNS 🌸

A string that should be freed with bson_free(). yes bestie, actually free it — no leaky vibes 🫶

👑 AUTHOR 👑

MongoDB, Inc

2009-present, MongoDB, Inc.

mwah 💋 this page is from libmongoc version 2.5.6, dated Oct 09, 202, and that's the whole vibe. periodt 🌈

📦 where this page comes from