mongoc_collection_find_indexes_with_opts()¶

Synopsis¶

mongoc_cursor_t *
mongoc_collection_find_indexes_with_opts (mongoc_collection_t *collection,
                                          const bson_t *opts);

Fetches a cursor containing documents, each corresponding to an index on this collection.

Parameters¶

collection: A mongoc_collection_t.
opts: A bson_t containing additional options.

Errors¶

Use mongoc_cursor_error() on the returned cursor to check for errors.

Returns¶

A cursor where each result corresponds to the server’s representation of an index on this collection. If the collection does not exist on the server, the cursor will be empty.

The cursor functions mongoc_cursor_set_limit(), mongoc_cursor_set_batch_size(), and mongoc_cursor_set_max_await_time_ms() have no use on the returned cursor.