FreeBSD Manual Pages
MONGOC_DATABAS...ND_COLLECTIONS(3) libmongocMONGOC_DATABAS...ND_COLLECTIONS(3) WARNING: Deprecated since version 1.9.0: Use mongoc_database_find_collections_with_opts() instead. SYNOPSIS mongoc_cursor_t * mongoc_database_find_collections (mongoc_database_t *database, const bson_t *filter, bson_error_t *error); DESCRIPTION Fetches a cursor containing documents, each corresponding to a collec- tion on this database. 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 • database: A mongoc_database_t. • filter: A matcher used by the server to filter the returned collec- tions. May be NULL. • 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, or NULL in case of error. The user must call mongoc_cursor_next() on the returned mongoc_cursor_t to execute the initial command. In the returned cursor each result corresponds to the server's repre- sentation of a collection in this database. 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, 202MONGOC_DATABAS...ND_COLLECTIONS(3)
WARNING: | SYNOPSIS | DESCRIPTION | PARAMETERS | ERRORS | RETURNS | AUTHOR | COPYRIGHT
Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=mongoc_database_find_collections&sektion=3&manpath=FreeBSD+Ports+14.3.quarterly>