Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
MONGOC_COLLECTION_FIND_INDEXES(3)  libmongoc MONGOC_COLLECTION_FIND_INDEXES(3)

WARNING:
	  Deprecated	      since	    version	    1.9.0:	   Use
	  mongoc_collection_find_indexes_with_opts() instead.

SYNOPSIS
	  mongoc_cursor_t *
	  mongoc_collection_find_indexes (mongoc_collection_t *collection,
					  bson_error_t *error);

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

       This  function  is considered a retryable read operation.  Upon a tran-
       sient 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
        collection: A mongoc_collection_t.

        error:	An optional location for a bson_error_t	or NULL.

ERRORS
       Errors are propagated via the error parameter.

RETURNS
       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 er-
	  ror.

       In the returned cursor each result corresponds to the  server's	repre-
       sentation  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  cur-
       sor.

AUTHOR
       MongoDB,	Inc

COPYRIGHT
       2009-present, MongoDB, Inc.

1.30.2				 Apr 12, 2025MONGOC_COLLECTION_FIND_INDEXES(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=mongoc_collection_find_indexes&sektion=3&manpath=FreeBSD+Ports+14.3.quarterly>

home | help