.\" Man page generated from reStructuredText.
.
.TH "MONGOC_DATABASE_FIND_COLLECTIONS_WITH_OPTS" "3" "Jun 04, 2021" "1.17.6" "libmongoc"
.SH NAME
mongoc_database_find_collections_with_opts \- mongoc_database_find_collections_with_opts()
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mongoc_cursor_t *
mongoc_database_find_collections_with_opts (mongoc_database_t *database,
                                            const bson_t *opts);
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Fetches a cursor containing documents, each corresponding to a collection on this database.
.sp
To get collection names only, use \fBmongoc_database_get_collection_names_with_opts\fP\&.
.sp
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 \fBretryreads\fP is false in the URI (see \fBmongoc_uri_t\fP) the retry behavior does not apply.
.SH PARAMETERS
.INDENT 0.0
.IP \(bu 2
\fBdatabase\fP: A \fBmongoc_database_t\fP\&.
.IP \(bu 2
\fBopts\fP: A \fI\%bson_t\fP containing additional options.
.UNINDENT
.sp
\fBopts\fP may be NULL or a BSON document with additional command options:
.INDENT 0.0
.IP \(bu 2
\fBsessionId\fP: First, construct a \fBmongoc_client_session_t\fP with \fBmongoc_client_start_session\fP\&. You can begin a transaction with \fBmongoc_client_session_start_transaction\fP, optionally with a \fBmongoc_transaction_opt_t\fP that overrides the options inherited from \fBdatabase\fP, and use \fBmongoc_client_session_append\fP to add the session to \fBopts\fP\&. See the example code for \fBmongoc_client_session_t\fP\&.
.IP \(bu 2
\fBserverId\fP: To target a specific server, include an int32 "serverId" field. Obtain the id by calling \fBmongoc_client_select_server\fP, then \fBmongoc_server_description_id\fP on its return value.
.UNINDENT
.sp
For a list of all options, see \fI\%the MongoDB Manual entry on the listCollections command\fP\&.
.SH ERRORS
.sp
Use \fBmongoc_cursor_error\fP on the returned cursor to check for errors.
.SH RETURNS
.sp
A cursor where each result corresponds to the server\(aqs representation of a collection in this database.
.sp
The cursor functions \fBmongoc_cursor_set_limit\fP, \fBmongoc_cursor_set_batch_size\fP, and \fBmongoc_cursor_set_max_await_time_ms\fP have no use on the returned cursor.
.SH EXAMPLES
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{
   bson_t opts = BSON_INITIALIZER;
   bson_t name_filter;
   const bson_t *doc;
   bson_iter_t iter;
   bson_error_t error;

   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\en", bson_iter_utf8 (&iter, NULL));
   }

   if (mongoc_cursor_error (cursor, &error))
      fprintf (stderr, "%s\en", error.msg);
   }

   mongoc_cursor_destroy (cursor);
   bson_destroy (&opts);
}
.ft P
.fi
.UNINDENT
.UNINDENT
.SH SEE ALSO
.sp
\fBmongoc_database_get_collection_names_with_opts()\fP
.SH AUTHOR
MongoDB, Inc
.SH COPYRIGHT
2017-present, MongoDB, Inc
.\" Generated by docutils manpage writer.
.