mongoc_collection_ensure_index man page

mongoc_collection_ensure_index() — None

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_FOR (mongoc_collection_create_index);

Deprecated

NOTE

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

Please use mongoc_collection_create_index(3) instead.

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.

Colophon

This page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.

Info

2016‐10‐21 MongoDB C Driver