mongoc_collection_keys_to_index_string(3)

mongoc_collection_keys_to_index_string()

Section 3 libmongoc-doc bookworm source

Description

mongoc_collection_keys_to_index_string - mongoc_collection_keys_to_index_string()

char *
mongoc_collection_keys_to_index_string (const bson_t *keys)
BSON_GNUC_WARN_UNUSED_RESULT;

•

keys: A bson_t.

This function returns the canonical stringification of a given key specification. See Creating 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.

A string that should be freed with bson_free().

MongoDB, Inc

2017-present, MongoDB, Inc