Provided by: libmongoc-doc_1.22.1-1_all bug

NAME

       mongoc_database_drop_with_opts - mongoc_database_drop_with_opts()

SYNOPSIS

          bool
          mongoc_database_drop_with_opts (mongoc_database_t *database,
                                          const bson_t *opts,
                                          bson_error_t *error);

PARAMETERS

database: A mongoc_database_t.

       • error: An optional location for a bson_error_t or NULL.

       opts may be NULL or a BSON document with additional command options:

       • writeConcern:  Construct  a mongoc_write_concern_t and use mongoc_write_concern_append()
         to   add   the   write    concern    to    opts.    See    the    example    code    for
         mongoc_client_write_command_with_opts().

       • 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.

       • collation: Configure textual comparisons. See Setting Collation Order, and  the  MongoDB
         Manual  entry  on Collation. Collation requires MongoDB 3.2 or later, otherwise an error
         is returned.

       • 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.

DESCRIPTION

       This function attempts to drop a database on the MongoDB server.

       If no write concern is provided in opts, the database's write concern is used.

       The encryptedFields document in opts may be used to  drop  a  collection  used  for  Using
       Client-Side Field Level Encryption.

ERRORS

       Errors are propagated via the error parameter.

RETURNS

       Returns true if successful. Returns false and sets error if there are invalid arguments or
       a server or network error.

AUTHOR

       MongoDB, Inc

COPYRIGHT

       2017-present, MongoDB, Inc