mongoc_collection_keys_to_index_string - Man Page

mongoc_collection_keys_to_index_string()

Synopsis

char *
mongoc_collection_keys_to_index_string (const bson_t *keys)
   BSON_GNUC_WARN_UNUSED_RESULT;

Parameters

Description

This function returns the canonical stringification of a given key specification. See create-indexes.

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().

Author

MongoDB, Inc

Info

Jan 06, 2022 1.20.1 libmongoc