---
name: "mongoc_database_find_collections_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_database_find_collections_with_opts"
---

# mongoc\_database\_find\_collections\_with\_opts(3)

## SYNOPSIS

```
mongoc_cursor_t *
mongoc_database_find_collections_with_opts (mongoc_database_t *database,
                                            const bson_t *opts);
```

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

To get collection names only, use *mongoc\_database\_get\_collection\_names\_with\_opts()*.

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

- •

  **database**: A *mongoc\_database\_t*.

- •

  **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 **database**, 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 listCollections command*.

## ERRORS

Use *mongoc\_cursor\_error()* on the returned cursor to check for errors.

## RETURNS

This function returns a newly allocated *mongoc\_cursor\_t* that should be freed with *mongoc\_cursor\_destroy()* when no longer in use. The returned *mongoc\_cursor\_t* is never **NULL**, even on error. The user must call *mongoc\_cursor\_next()* on the returned *mongoc\_cursor\_t* to execute the initial command.

Cursor errors can be checked with *mongoc\_cursor\_error\_document()*. It always fills out the *bson\_error\_t* if an error occurred, and optionally includes a server reply document if the error occurred server-side.

**WARNING:**

Failure to handle the result of this function is a programming error.

In the returned cursor each result corresponds to the server's representation 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 cursor.

## EXAMPLES

```
{
   bson_t opts = BSON_INITIALIZER;
   bson_t name_filter;
   const bson_t *doc;
   bson_iter_t iter;
   bson_error_t error;
   mongoc_cursor_t *cursor;
   BSON_APPEND_DOCUMENT_BEGIN (&opts, "filter", &name_filter);
   /* find collections with names like "abbbbc" */
   BSON_APPEND_REGEX (&name_filter, "name", "ab+c", NULL);
   bson_append_document_end (&opts, &name_filter);
   cursor = mongoc_database_find_collections_with_opts (database, &opts);
   while (mongoc_cursor_next (cursor, &doc)) {
      bson_iter_init_find (&iter, doc, "name");
      printf ("found collection: %s\n", bson_iter_utf8 (&iter, NULL));
   }
   if (mongoc_cursor_error (cursor, &error)) {
      fprintf (stderr, "%s\n", error.message);
   }
   mongoc_cursor_destroy (cursor);
   bson_destroy (&opts);
}
```

**SEE ALSO:**

```
mongoc_database_get_collection_names_with_opts()
```

## AUTHOR

MongoDB, Inc

## COPYRIGHT

2009-present, MongoDB, Inc.