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
63
64
65
66
67
68
69
70
|
/**
* Copyright (C) 2021-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.
*/
#pragma once
#include <memory>
#include <vector>
#include "mongo/db/catalog/collection.h"
#include "mongo/db/catalog/index_catalog_entry.h"
namespace mongo {
/**
* A utility which, on construction, takes note of all indices for a given collection. The caller
* can subsequently check whether any of those indices have been dropped.
*/
class AllIndicesRequiredChecker {
public:
/**
* Constructs an 'AllIndicesRequiredChecker' which can be used later to ensure that none of the
* indices for the given 'collection' have been dropped. The caller must hold the appropriate
* db_raii object in order to read the collection's index catalog.
*/
explicit AllIndicesRequiredChecker(const CollectionPtr& collection);
/**
* Throws a 'QueryPlanKilled' error if any of the indices which existed at the time of
* construction have since been dropped.
*/
void check() const;
private:
// This class holds weak pointers to all of the index catalog entries known at the time of
// construction. Later, we can attempt to lock each weak pointer in order to determine whether
// an index in the list has been destroyed. If we can lock the weak pointer, we need to check
// the 'isDropped()' flag on the index catalog entry.
std::vector<std::weak_ptr<const IndexCatalogEntry>> _indexCatalogEntries;
// The names of the indices above. Used for error reporting.
std::vector<std::string> _indexNames;
};
} // namespace mongo
|
