mongoc_collection_keys_to_index_string(3)

mongoc_collection_keys_to_index_string3

Usage

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.

Overview

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.

Returns

A string that should be freed with bson_free().

Releases

5 releases since Debian 9 (Stretch); the text changed 4 times.

  1. 9
  2. 10
  3. 11
  4. 12
  5. 13

Author

MongoDB, Inc

From libmongoc-doc 1.30.4-1+deb13u3 in Debian 13 (Trixie). Parsed by carta from the page's man source.