mongoc_collection_keys_to_index_string(3)
| MONGOC_COLLECTION_KEYS_TO_INDEX_STRING(3) | libmongoc | MONGOC_COLLECTION_KEYS_TO_INDEX_STRING(3) |
SYNOPSIS
char * mongoc_collection_keys_to_index_string (const bson_t *keys);
PARAMETERS
- •
- keys: A bson_t <https://www.mongoc.org/libbson/current/bson_t.html>. This is expected to match the form of the key field in the createIndexes <https://www.mongodb.com/docs/manual/reference/command/createIndexes/> command.
DESCRIPTION
This function returns the canonical stringification of a given key specification. See Manage Collection Indexes <https://www.mongodb.com/docs/languages/c/c-driver/current/libmongoc/guides/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.
RETURNS
A string that should be freed with bson_free() <https://www.mongoc.org/libbson/current/bson_free.html>.
Author
MongoDB, Inc
Copyright
2009-present, MongoDB, Inc.
| February 10, 2026 | 1.30.7 |