summaryrefslogtreecommitdiff
path: root/src/mongo/db/catalog/drop_indexes.h
blob: c465f6dab52385659ec109565c3660042144610b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
/**
 *    Copyright (C) 2018-present MongoDB, Inc.
 *
 *    This program is free software: you can redistribute it and/or modify
 *    it under the terms of the Server Side Public License, version 1,
 *    as published by MongoDB, Inc.
 *
 *    This program is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *    Server Side Public License for more details.
 *
 *    You should have received a copy of the Server Side Public License
 *    along with this program. If not, see
 *    <http://www.mongodb.com/licensing/server-side-public-license>.
 *
 *    As a special exception, the copyright holders give permission to link the
 *    code of portions of this program with the OpenSSL library under certain
 *    conditions as described in each individual source file and distribute
 *    linked combinations including the program with the OpenSSL library. You
 *    must comply with the Server Side Public License in all respects for
 *    all of the code used other than as permitted herein. If you modify file(s)
 *    with this exception, you may extend this exception to your version of the
 *    file(s), but you are not obligated to do so. If you do not wish to do so,
 *    delete this exception statement from your version. If you delete this
 *    exception statement from all source files in the program, then also delete
 *    it in the license file.
 */

#include "mongo/base/status.h"

namespace mongo {
class BSONObj;
class BSONObjBuilder;
class NamespaceString;
class OperationContext;

/**
 * Drops one or more ready indexes, or aborts a single index builder from the "nss" collection that
 * matches the caller's "cmdObj" input. Populates "result" with some statistics about the operation.
 *
 * "cmdObj" must have a field named "index" that has one of the following as its value:
 * 1) "*" <-- Aborts all index builders and drops all ready indexes except the _id index.
 * 2) "indexName" <-- Aborts an index builder or drops a ready index with the given name.
 * 3) { keyPattern } <-- Aborts an index builder or drops a ready index with a matching key pattern.
 * 4) ["indexName1", ..., "indexNameN"] <-- Aborts an index builder or drops ready indexes that
 *                                          match the given names.
 */
Status dropIndexes(OperationContext* opCtx,
                   const NamespaceString& nss,
                   const BSONObj& cmdObj,
                   BSONObjBuilder* result);

/**
 * Same behaviour as "dropIndexes" but only drops ready indexes.
 */
Status dropIndexesForApplyOps(OperationContext* opCtx,
                              const NamespaceString& nss,
                              const BSONObj& cmdObj,
                              BSONObjBuilder* result);

}  // namespace mongo