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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
|
/**
* 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.
*/
#pragma once
#include <string>
#include <vector>
#include "mongo/db/catalog/collection_options.h"
#include "mongo/db/index/multikey_paths.h"
namespace mongo {
/**
* This is a helper class for any storage engine that wants to store catalog information
* as BSON. It is totally optional to use this.
*/
class BSONCollectionCatalogEntry {
public:
static const StringData kIndexBuildScanning;
static const StringData kIndexBuildDraining;
/**
* Incremented when breaking changes are made to the index build procedure so that other servers
* know whether or not to resume or discard unfinished index builds.
*/
static constexpr int kIndexBuildVersion = 1;
BSONCollectionCatalogEntry() = default;
virtual ~BSONCollectionCatalogEntry() {}
// ------ for implementors
struct IndexMetaData {
IndexMetaData() {}
IndexMetaData(const IndexMetaData& other)
: spec(other.spec),
ready(other.ready),
isBackgroundSecondaryBuild(other.isBackgroundSecondaryBuild),
buildUUID(other.buildUUID) {
// We need to hold the multikey mutex when copying, someone else might be modifying this
stdx::lock_guard lock(other.multikeyMutex);
multikey = other.multikey;
multikeyPaths = other.multikeyPaths;
}
IndexMetaData& operator=(IndexMetaData&& rhs) {
spec = std::move(rhs.spec);
ready = std::move(rhs.ready);
isBackgroundSecondaryBuild = std::move(rhs.isBackgroundSecondaryBuild);
buildUUID = std::move(rhs.buildUUID);
// No need to hold mutex on move, there are no concurrent readers while we're moving the
// instance.
multikey = std::move(rhs.multikey);
multikeyPaths = std::move(rhs.multikeyPaths);
return *this;
}
void updateTTLSetting(long long newExpireSeconds);
void updateHiddenSetting(bool hidden);
std::string name() const {
return spec["name"].String();
}
BSONObj spec;
bool ready = false;
bool isBackgroundSecondaryBuild = false;
// If initialized, a two-phase index build is in progress.
boost::optional<UUID> buildUUID;
// If non-empty, 'multikeyPaths' is a vector with size equal to the number of elements in
// the index key pattern. Each element in the vector is an ordered set of positions
// (starting at 0) into the corresponding indexed field that represent what prefixes of the
// indexed field cause the index to be multikey.
// multikeyMutex must be held when accessing multikey or multikeyPaths
mutable Mutex multikeyMutex;
mutable bool multikey = false;
mutable MultikeyPaths multikeyPaths;
};
struct MetaData {
void parse(const BSONObj& obj);
/**
* If we have exclusive access to this MetaData (holding a unique copy). We don't need to
* hold mutexes when reading internal data.
*/
BSONObj toBSON(bool hasExclusiveAccess = false) const;
int findIndexOffset(StringData name) const;
/**
* Removes information about an index from the MetaData. Returns true if an index
* called name existed and was deleted, and false otherwise.
*/
bool eraseIndex(StringData name);
std::string ns;
CollectionOptions options;
std::vector<IndexMetaData> indexes;
};
};
} // namespace mongo
|
