1MONGOC_DATABASE_DROP_WITH_OPTS(3)  libmongoc MONGOC_DATABASE_DROP_WITH_OPTS(3)
2
3
4

NAME

6       mongoc_database_drop_with_opts - mongoc_database_drop_with_opts()
7

SYNOPSIS

9          bool
10          mongoc_database_drop_with_opts (mongoc_database_t *database,
11                                          const bson_t *opts,
12                                          bson_error_t *error);
13

PARAMETERS

15       • database: A mongoc_database_t.
16
17       • error: An optional location for a bson_error_t or NULL.
18
19       opts may be NULL or a BSON document with additional command options:
20
21       • writeConcern:   Construct   a  mongoc_write_concern_t  and  use  mon‐
22         goc_write_concern_append to add the write concern to  opts.  See  the
23         example code for mongoc_client_write_command_with_opts.
24
25       • sessionId:  First,  construct  a  mongoc_client_session_t  with  mon‐
26         goc_client_start_session. You  can  begin  a  transaction  with  mon‐
27         goc_client_session_start_transaction, optionally with a mongoc_trans‐
28         action_opt_t that overrides the options inherited from database,  and
29         use  mongoc_client_session_append to add the session to opts. See the
30         example code for mongoc_client_session_t.
31
32       • collation: Configure textual comparisons. See Setting  Collation  Or‐
33         der,  and  the  MongoDB Manual entry on Collation. Collation requires
34         MongoDB 3.2 or later, otherwise an error is returned.
35
36       • serverId: To target a specific server, include  an  int32  "serverId"
37         field.  Obtain  the  id  by calling mongoc_client_select_server, then
38         mongoc_server_description_id on its return value.
39

DESCRIPTION

41       This function attempts to drop a database on the MongoDB server.
42
43       If no write concern is provided in opts, the database's  write  concern
44       is used.
45

ERRORS

47       Errors are propagated via the error parameter.
48

RETURNS

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

AUTHOR

54       MongoDB, Inc
55

57       2017-present, MongoDB, Inc
58
59
60
61
621.20.0                           Nov 18, 2021MONGOC_DATABASE_DROP_WITH_OPTS(3)
Impressum