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_collection_drop_in‐
7       dex_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
26         mongoc_write_concern_append()  to  add the write concern to opts. See
27         the example code for mongoc_client_write_command_with_opts().
28
29       • sessionId:   First,   construct   a   mongoc_client_session_t    with
30         mongoc_client_start_session().  You  can  begin  a  transaction  with
31         mongoc_client_session_start_transaction(),    optionally    with    a
32         mongoc_transaction_opt_t  that  overrides  the options inherited from
33         collection, and use mongoc_client_session_append() to add the session
34         to opts. See the example code for mongoc_client_session_t.
35
36       • collation:  Configure  textual comparisons. See Setting Collation Or‐
37         der, 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
57       SEE ALSO:
58          Manage Collection Indexes.
59
60

AUTHOR

62       MongoDB, Inc
63

65       2017-present, MongoDB, Inc
66
67
68
69
701.24.3                           Aug 1M7O,NG2O0C2_3COLLECTION_DROP_INDEX_WITH_OPTS(3)
Impressum