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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
|
/**
* 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 <boost/optional.hpp>
#include <functional>
#include <string>
#include "mongo/base/owned_pointer_vector.h"
#include "mongo/bson/ordering.h"
#include "mongo/bson/timestamp.h"
#include "mongo/db/index/multikey_paths.h"
#include "mongo/db/record_id.h"
#include "mongo/db/storage/kv/kv_prefix.h"
#include "mongo/platform/atomic_word.h"
#include "mongo/stdx/mutex.h"
#include "mongo/util/debug_util.h"
namespace mongo {
class CollatorInterface;
class CollectionCatalogEntry;
class CollectionInfoCache;
class IndexAccessMethod;
class IndexBuildInterceptor;
class IndexDescriptor;
class MatchExpression;
class OperationContext;
class IndexCatalogEntry {
public:
IndexCatalogEntry() = default;
virtual ~IndexCatalogEntry() = default;
inline IndexCatalogEntry(IndexCatalogEntry&&) = delete;
inline IndexCatalogEntry& operator=(IndexCatalogEntry&&) = delete;
virtual const NamespaceString& ns() const = 0;
virtual void init(std::unique_ptr<IndexAccessMethod> accessMethod) = 0;
virtual IndexDescriptor* descriptor() = 0;
virtual const IndexDescriptor* descriptor() const = 0;
virtual IndexAccessMethod* accessMethod() = 0;
virtual const IndexAccessMethod* accessMethod() const = 0;
virtual bool isHybridBuilding() const = 0;
virtual IndexBuildInterceptor* indexBuildInterceptor() = 0;
virtual const IndexBuildInterceptor* indexBuildInterceptor() const = 0;
virtual void setIndexBuildInterceptor(IndexBuildInterceptor* interceptor) = 0;
virtual const Ordering& ordering() const = 0;
virtual const MatchExpression* getFilterExpression() const = 0;
virtual const CollatorInterface* getCollator() const = 0;
/// ---------------------
virtual void setIsReady(const bool newIsReady) = 0;
// --
/**
* Returns true if this index is multikey and false otherwise.
*/
virtual bool isMultikey(OperationContext* opCtx) const = 0;
/**
* Returns the path components that cause this index to be multikey if this index supports
* path-level multikey tracking, and returns an empty vector if path-level multikey tracking
* isn't supported.
*
* If this index supports path-level multikey tracking but isn't multikey, then this function
* returns a vector with size equal to the number of elements in the index key pattern where
* each element in the vector is an empty set.
*/
virtual MultikeyPaths getMultikeyPaths(OperationContext* const opCtx) const = 0;
/**
* Sets this index to be multikey. Information regarding which newly detected path components
* cause this index to be multikey can also be specified.
*
* If this index doesn't support path-level multikey tracking, then 'multikeyPaths' is ignored.
*
* If this index supports path-level multikey tracking, then 'multikeyPaths' must be a vector
* with size equal to the number of elements in the index key pattern. Additionally, at least
* one path component of the indexed fields must cause this index to be multikey.
*
* If isTrackingMultikeyPathInfo() is set on the OperationContext's MultikeyPathTracker,
* then after we confirm that we actually need to set the index as multikey, we will save the
* namespace, index name, and multikey paths on the OperationContext rather than set the index
* as multikey here.
*/
virtual void setMultikey(OperationContext* const opCtx, const MultikeyPaths& multikeyPaths) = 0;
/**
* TODO SERVER-36385 Remove this function: we don't set the feature tracker bit in 4.4
* because 4.4 can only downgrade to 4.2 which can read long TypeBits.
*/
virtual void setIndexKeyStringWithLongTypeBitsExistsOnDisk(OperationContext* const opCtx) = 0;
// if this ready is ready for queries
virtual bool isReady(OperationContext* const opCtx) const = 0;
virtual KVPrefix getPrefix() const = 0;
/**
* If return value is not boost::none, reads with majority read concern using an older snapshot
* must treat this index as unfinished.
*/
virtual boost::optional<Timestamp> getMinimumVisibleSnapshot() = 0;
virtual void setMinimumVisibleSnapshot(const Timestamp name) = 0;
virtual void setNs(NamespaceString ns) = 0;
};
class IndexCatalogEntryContainer {
public:
typedef std::vector<std::shared_ptr<IndexCatalogEntry>>::const_iterator const_iterator;
typedef std::vector<std::shared_ptr<IndexCatalogEntry>>::const_iterator iterator;
const_iterator begin() const {
return _entries.begin();
}
const_iterator end() const {
return _entries.end();
}
iterator begin() {
return _entries.begin();
}
iterator end() {
return _entries.end();
}
// TODO: these have to be SUPER SUPER FAST
// maybe even some pointer trickery is in order
const IndexCatalogEntry* find(const IndexDescriptor* desc) const;
IndexCatalogEntry* find(const IndexDescriptor* desc);
IndexCatalogEntry* find(const std::string& name);
/**
* Returns a pointer to the IndexCatalogEntry corresponding to 'desc', where the caller assumes
* shared ownership of the catalog object. Returns null if the entry does not exist.
*/
std::shared_ptr<IndexCatalogEntry> findShared(const IndexDescriptor* desc) const;
unsigned size() const {
return _entries.size();
}
// -----------------
/**
* Removes from _entries and returns the matching entry or NULL if none matches.
*/
std::shared_ptr<IndexCatalogEntry> release(const IndexDescriptor* desc);
bool remove(const IndexDescriptor* desc) {
return static_cast<bool>(release(desc));
}
void add(std::shared_ptr<IndexCatalogEntry>&& entry) {
_entries.push_back(std::move(entry));
}
std::vector<std::shared_ptr<const IndexCatalogEntry>> getAllEntries() const {
return {_entries.begin(), _entries.end()};
}
private:
std::vector<std::shared_ptr<IndexCatalogEntry>> _entries;
};
} // namespace mongo
|
