Scroll to navigation

MONGOC_COLLECTION_ENSURE_INDEX(3) libmongoc MONGOC_COLLECTION_ENSURE_INDEX(3)

NAME

mongoc_collection_ensure_index - mongoc_collection_ensure_index()

SYNOPSIS

bool
mongoc_collection_ensure_index (mongoc_collection_t *collection,


                                const bson_t *keys,


                                const mongoc_index_opt_t *opt,


                                bson_error_t *error)


   BSON_GNUC_DEPRECATED;


DEPRECATED

This function is deprecated and should not be used in new code. See Creating Indexes.

PARAMETERS

  • collection: A mongoc_collection_t.
  • keys: A bson_t.
  • opt: A mongoc_index_opt_t.
  • error: An optional location for a bson_error_t or NULL.

ERRORS

Errors are propagated via the error parameter.

AUTHOR

MongoDB, Inc

COPYRIGHT

2017-present, MongoDB, Inc

August 31, 2022 1.23.0