1MONGOC_COLLECTION_DROP_INDEX_WITH_OPlTiSbM(mO3oN)nGgOoCc_COLLECTION_DROP_INDEX_WITH_OPTS(3)
2
3
4

NAME

6       mongoc_collection_drop_index_with_opts         -         mongoc_collec‐
7       tion_drop_index_with_opts()
8

SYNOPSIS

10          bool
11          mongoc_collection_drop_index_with_opts (mongoc_collection_t *collection,
12                                                  const char *index_name,
13                                                  const bson_t *opts,
14                                                  bson_error_t *error);
15

PARAMETERS

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

DESCRIPTION

45       This function requests than an index on collection be dropped.
46
47       If no write concern is provided in opts, the collection's write concern
48       is used.
49

ERRORS

51       Errors are propagated via the error parameter.
52

RETURNS

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

AUTHOR

58       MongoDB, Inc
59

61       2017-present, MongoDB, Inc
62
63
64
65
661.16.2                           Feb 2M5O,NG2O0C2_0COLLECTION_DROP_INDEX_WITH_OPTS(3)
Impressum