Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
MONGOC_COLLECT...O_INDEX_STRING(3) libmongocMONGOC_COLLECT...O_INDEX_STRING(3)

SYNOPSIS
	  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.

DESCRIPTION
       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 in-
       dex, such one other than	a straight index with ascending	 and  descend-
       ing.

RETURNS
       A string	that should be freed with bson_free().

AUTHOR
       MongoDB,	Inc

COPYRIGHT
       2009-present, MongoDB, Inc.

1.30.2				 Apr 12, 202MONGOC_COLLECT...O_INDEX_STRING(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=mongoc_collection_keys_to_index_string&sektion=3&manpath=FreeBSD+Ports+14.3.quarterly>

home | help