.\" Man page generated from reStructuredText. . . .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 .. .TH "MONGOC_DATABASE_FIND_COLLECTIONS" "3" "May 07, 2024" "1.27.1" "libmongoc" .sp \fBWARNING:\fP .INDENT 0.0 .INDENT 3.5 Deprecated since version 1.9.0: This function is deprecated and should not be used in new code. .sp Please use \fI\%mongoc_database_find_collections_with_opts()\fP in new code. .UNINDENT .UNINDENT .SH SYNOPSIS .INDENT 0.0 .INDENT 3.5 .sp .EX mongoc_cursor_t * mongoc_database_find_collections (mongoc_database_t *database, const bson_t *filter, bson_error_t *error) BSON_GNUC_WARN_UNUSED_RESULT BSON_GNUC_DEPRECATED_FOR (mongoc_database_find_collections_with_opts); .EE .UNINDENT .UNINDENT .SH DESCRIPTION .sp Fetches a cursor containing documents, each corresponding to a collection on this database. .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 \fI\%mongoc_uri_t\fP) the retry behavior does not apply. .SH PARAMETERS .INDENT 0.0 .IP \(bu 2 \fBdatabase\fP: A \fI\%mongoc_database_t\fP\&. .IP \(bu 2 \fBfilter\fP: A matcher used by the server to filter the returned collections. May be \fBNULL\fP\&. .IP \(bu 2 \fBerror\fP: An optional location for a \fI\%bson_error_t\fP or \fBNULL\fP\&. .UNINDENT .SH ERRORS .sp Errors are propagated via the \fBerror\fP parameter. .SH RETURNS .sp This function returns a newly allocated \fI\%mongoc_cursor_t\fP that should be freed with \fI\%mongoc_cursor_destroy()\fP when no longer in use, or \fINULL\fP in case of error. The user must call \fI\%mongoc_cursor_next()\fP on the returned \fI\%mongoc_cursor_t\fP to execute the initial command. .sp In the returned cursor each result corresponds to the server\(aqs representation of a collection in this database. .sp The cursor functions \fI\%mongoc_cursor_set_limit()\fP, \fI\%mongoc_cursor_set_batch_size()\fP, and \fI\%mongoc_cursor_set_max_await_time_ms()\fP have no use on the returned cursor. .SH AUTHOR MongoDB, Inc .SH COPYRIGHT 2017-present, MongoDB, Inc .\" Generated by docutils manpage writer. .