.\" Man page generated from reStructuredText.
.
.TH "MONGOC_DATABASE_GET_COLLECTION_NAMES_WITH_OPTS" "3" "Jun 04, 2021" "1.17.6" "libmongoc"
.SH NAME
mongoc_database_get_collection_names_with_opts \- mongoc_database_get_collection_names_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
char **
mongoc_database_get_collection_names_with_opts (mongoc_database_t *database,
                                                const bson_t *opts,
                                                bson_error_t *error);
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Fetches a \fBNULL\fP terminated array of \fBNULL\-byte\fP terminated \fBchar*\fP strings containing the names of all of the collections in \fBdatabase\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.
.IP \(bu 2
\fBerror\fP: An optional location for a \fBbson_error_t\fP or \fBNULL\fP\&.
.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
Errors are propagated via the \fBerror\fP parameter.
.SH RETURNS
.sp
A \fBNULL\fP terminated array of \fBNULL\fP terminated \fBchar*\fP strings that should be freed with \fI\%bson_strfreev()\fP\&. Upon failure, \fBNULL\fP is returned and \fBerror\fP is set.
.SH EXAMPLES
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{
   bson_t opts = BSON_INITIALIZER;
   mongoc_read_concern_t *rc;
   bson_error_t error;
   char **strv;
   unsigned i;

   rc = mongoc_read_concern_new ();
   mongoc_read_concern_set_level (rc, MONGOC_READ_CONCERN_LEVEL_MAJORITY);
   mongoc_read_concern_append (rc, &opts);
   if ((strv = mongoc_database_get_collection_names_with_opts (
          database, &opts, &error))) {

      for (i = 0; strv[i]; i++)
         printf ("%s\en", strv[i]);

      bson_strfreev (strv);
   } else {
      fprintf (stderr, "Command failed: %s\en", error.message);
   }

   mongoc_read_concern_destroy (rc);
   bson_destroy (&opts);
}
.ft P
.fi
.UNINDENT
.UNINDENT
.SH AUTHOR
MongoDB, Inc
.SH COPYRIGHT
2017-present, MongoDB, Inc
.\" Generated by docutils manpage writer.
.