Ubuntu Manpages

PARAMETERS

WARNING:

Deprecated since version 1.9.0: This function is deprecated and should not be used in new code.

Please use mongoc_collection_find_indexes_with_opts() in new code.



  • collection: A mongoc_collection_t.
  • error: An optional location for a bson_error_t or NULL.

Errors are propagated via the error parameter.

This function returns a newly allocated mongoc_cursor_t that should be freed with mongoc_cursor_destroy() when no longer in use. The returned mongoc_cursor_t is never NULL, even on error. The user must call mongoc_cursor_next() on the returned mongoc_cursor_t to execute the initial command.

Cursor errors can be checked with mongoc_cursor_error_document(). It always fills out the bson_error_t if an error occurred, and optionally includes a server reply document if the error occurred server-side.

WARNING:

Failure to handle the result of this function is a programming error.


In the returned cursor 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.

MongoDB, Inc

2017-present, MongoDB, Inc