mongoc_collection_find_indexes_with_opts

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.

This function is considered a retryable read operation. Upon a transient error (a network error, errors due to replica set failover, etc.) the operation is safely retried once. If retryreads is false in the URI (see mongoc_uri_t) the retry behavior does not apply.

Parameters

opts may be NULL or a BSON document with additional command 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.

Author

MongoDB, Inc

Info

Feb 04, 2021 1.17.4 libmongoc