---
name: "mongoc_client_get_database_names_with_opts"
section: "3"
platform: "linux"
package: "libmongoc-doc"
version: "1.30.4-1+deb13u3"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/mongoc_client_get_database_names_with_opts"
---

# mongoc\_client\_get\_database\_names\_with\_opts(3)

## SYNOPSIS

```
char **
mongoc_client_get_database_names_with_opts (mongoc_client_t *client,
                                            const bson_t *opts,
                                            bson_error_t *error);
```

This function queries the MongoDB server for a list of known databases.

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

- •

  **client**: A *mongoc\_client\_t*.

- •

  **opts**: A *bson\_t* containing additional options.

- •

  **error**: An optional location for a *bson\_error\_t* or **NULL**.

**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

Errors are propagated via the **error** parameter.

## RETURNS

A **NULL** terminated vector of **NULL-byte** terminated strings. The result should be freed with *bson\_strfreev()*.

**NULL** is returned upon failure and **error** is set.

## EXAMPLES

```
{
   bson_error_t error;
   char **strv;
   unsigned i;
   if ((strv = mongoc_client_get_database_names_with_opts (client, NULL, &error))) {
      for (i = 0; strv[i]; i++)
         printf ("%s\n", strv[i]);
      bson_strfreev (strv);
   } else {
      fprintf (stderr, "Command failed: %s\n", error.message);
   }
}
```

## AUTHOR

MongoDB, Inc

## COPYRIGHT

2009-present, MongoDB, Inc.