MONGOC_CLIENT_...ASES_WITH_OPTS(3)

📦
version 2.5.6 · 16 versions
, in epel 10

💅 mongoc_client_find_databases_with_opts 💅

okay so bestie, this is a libmongoc manual page, and it's lowkey giving “list every database on this MongoDB server” energy. no cap, let’s get into it. 🦋

✨ SYNOPSIS ✨

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

This function fetches a cursor containing documents, and each document corresponds to a database on this MongoDB server. 🫶

It’s considered a retryable read operation, periodt. If a transient error happens (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), then the retry behavior does not apply. 💅

🌸 PARAMETERS 🌸

  • client — a mongoc_client_t. the main character client. ✨
  • opts — a bson_t containing additional options.

opts may be NULL or a BSON document with additional command options: 💖

  • sessionId — first, construct a mongoc_client_session_t with mongoc_client_start_session(). You can begin a transaction with mongoc_client_session_start_transaction(), optionally with a mongoc_transaction_opt_t that overrides the options inherited from client, and use mongoc_client_session_append() to add the session to opts. See the example code for mongoc_client_session_t. 🎀
  • serverId — to target a specific server, include an int32 "serverId" field. Obtain the id by calling mongoc_client_select_server(), then mongoc_server_description_id() on its return value. 🔥

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. that’s the vibe check, bestie.

👑 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. like, none. 🙈

🧚 AUTHOR 🧚

MongoDB, Inc

2009-present, MongoDB, Inc.

mwah 💖 this page is from libmongoc 2.5.6, dated Oct 09, 202 — k bye bestie, go fetch those databases! 🎀

📦 where this page comes from