SYNOPSIS

char * mongoc_collection_keys_to_index_string (const bson_t *keys);

DESCRIPTION

The mongoc_collection_keys_to_index_string() function shall returns the canonical stringification, as used in mongoc_collection_ensure_index(3) without an explicit name, of a given key specification.

It is a programming error to call this function on a non-standard index. I.e. one other than a straight index with ascending and descending.

The string is heap allocated and must be freed.

RETURN VALUE

The mongoc_collection_keys_to_index_string() function returns a string.

ERRORS

No errors are defined.

SEE ALSO

AUTHORS

This page was written by MongoDB Inc.