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

SYNOPSIS

6          bool
7          mongoc_collection_drop_index_with_opts (mongoc_collection_t *collection,
8                                                  const char *index_name,
9                                                  const bson_t *opts,
10                                                  bson_error_t *error);
11

PARAMETERS

13       • collection: A mongoc_collection_t.
14
15       • index_name: A string containing the name of the index.
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
22         mongoc_write_concern_append() to add the write concern to  opts.  See
23         the example code for mongoc_client_write_command_with_opts().
24
25       • sessionId:    First,   construct   a   mongoc_client_session_t   with
26         mongoc_client_start_session().  You  can  begin  a  transaction  with
27         mongoc_client_session_start_transaction(),    optionally    with    a
28         mongoc_transaction_opt_t that overrides the  options  inherited  from
29         collection, and use mongoc_client_session_append() to add the session
30         to opts. See the 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 requests than an index on collection be dropped.
42
43       If no write concern is provided in opts, the collection'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
53       SEE ALSO:
54          Manage Collection Indexes.
55
56

AUTHOR

58       MongoDB, Inc
59

61       2017-present, MongoDB, Inc
62
63
64
65
661.25.1                           Nov 0M8O,NG2O0C2_3COLLECTION_DROP_INDEX_WITH_OPTS(3)
Impressum