Man page - mongoc_collection_keys_to_index_string(3)

Packages contas this manual

Manual

MONGOC_COLLECTION_KEYS_TO_INDEX_STRING(3) libmongoc MONGOC_COLLECTION_KEYS_TO_INDEX_STRING(3)

char *
mongoc_collection_keys_to_index_string (const bson_t *keys);


keys: A bson_t. This is expected to match the form of the key field in the createIndexes command.

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, such one other than a straight index with ascending and descending.

A string that should be freed with bson_free().

MongoDB, Inc

2009-present, MongoDB, Inc.

December 18, 2025 1.30.4