mongoc_client_find_databases_with_opts - Man Page

mongoc_client_find_databases_with_opts()

Synopsis

mongoc_cursor_t *
mongoc_client_find_databases_with_opts (
   mongoc_client_t *client, const bson_t *opts) BSON_GNUC_WARN_UNUSED_RESULT;

Fetches a cursor containing documents, each corresponding to a database on this MongoDB server.

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:

For a list of all options, see the MongoDB Manual entry on the listDatabases command.

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 a 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 cursor.

Author

MongoDB, Inc

Info

Sep 08, 2022 1.23.0 libmongoc