1MONGOC_DATABASE_FIND_COLLECTIONS(3)libmongocMONGOC_DATABASE_FIND_COLLECTIONS(3)
2
3
4

NAME

6       mongoc_database_find_collections - mongoc_database_find_collections()
7
8       WARNING:
9          Deprecated  since  version  1.9.0:  This  function is deprecated and
10          should not be used in new code.
11
12          Please use mongoc_database_find_collections_with_opts() in new code.
13
14

SYNOPSIS

16          mongoc_cursor_t *
17          mongoc_database_find_collections (mongoc_database_t *database,
18                                            const bson_t *filter,
19                                            bson_error_t *error)
20             BSON_GNUC_WARN_UNUSED_RESULT
21             BSON_GNUC_DEPRECATED_FOR (mongoc_database_find_collections_with_opts);
22

DESCRIPTION

24       Fetches a cursor containing documents, each corresponding to a  collec‐
25       tion on this database.
26
27       This  function  is considered a retryable read operation.  Upon a tran‐
28       sient error (a network error, errors due to replica set failover, etc.)
29       the  operation  is  safely retried once.  If retryreads is false in the
30       URI (see mongoc_uri_t) the retry behavior does not apply.
31

PARAMETERS

33       • database: A mongoc_database_t.
34
35       • filter: A matcher used by the server to filter the  returned  collec‐
36         tions. May be NULL.
37
38       • error: An optional location for a bson_error_t or NULL.
39

ERRORS

41       Errors are propagated via the error parameter.
42

RETURNS

44       This  function returns a newly allocated mongoc_cursor_t that should be
45       freed with mongoc_cursor_destroy() when no longer in use,  or  NULL  in
46       case  of error. The user must call mongoc_cursor_next() on the returned
47       mongoc_cursor_t to execute the initial command.
48
49       In the returned cursor each result corresponds to the  server's  repre‐
50       sentation of a collection in this database.
51
52       The         cursor         functions         mongoc_cursor_set_limit(),
53       mongoc_cursor_set_batch_size(),                                     and
54       mongoc_cursor_set_max_await_time_ms()  have no use on the returned cur‐
55       sor.
56

AUTHOR

58       MongoDB, Inc
59

61       2017-present, MongoDB, Inc
62
63
64
65
661.24.3                           Aug 17, 202M3ONGOC_DATABASE_FIND_COLLECTIONS(3)
Impressum