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
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
|
// index_catalog.h
/**
* Copyright (C) 2013-2014 MongoDB Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* 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
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* 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 GNU Affero General 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 <vector>
#include "mongo/db/catalog/index_catalog_entry.h"
#include "mongo/db/jsobj.h"
#include "mongo/db/operation_context.h"
#include "mongo/db/record_id.h"
#include "mongo/db/storage/record_store.h"
#include "mongo/platform/unordered_map.h"
namespace mongo {
class Client;
class Collection;
class IndexDescriptor;
class IndexAccessMethod;
/**
* how many: 1 per Collection
* lifecycle: attached to a Collection
*/
class IndexCatalog {
public:
IndexCatalog(Collection* collection);
~IndexCatalog();
// must be called before used
Status init(OperationContext* txn);
bool ok() const;
// ---- accessors -----
bool haveAnyIndexes() const;
int numIndexesTotal(OperationContext* txn) const;
int numIndexesReady(OperationContext* txn) const;
int numIndexesInProgress(OperationContext* txn) const {
return numIndexesTotal(txn) - numIndexesReady(txn);
}
/**
* this is in "alive" until the Collection goes away
* in which case everything from this tree has to go away
*/
bool haveIdIndex(OperationContext* txn) const;
/**
* Returns the spec for the id index to create by default for this collection.
*/
BSONObj getDefaultIdIndexSpec() const;
IndexDescriptor* findIdIndex(OperationContext* txn) const;
/**
* @return null if cannot find
*/
IndexDescriptor* findIndexByName(OperationContext* txn,
StringData name,
bool includeUnfinishedIndexes = false) const;
/**
* @return null if cannot find
*/
IndexDescriptor* findIndexByKeyPattern(OperationContext* txn,
const BSONObj& key,
bool includeUnfinishedIndexes = false) const;
/**
* Returns an index suitable for shard key range scans.
*
* This index:
* - must be prefixed by 'shardKey', and
* - must not be a partial index.
*
* If the parameter 'requireSingleKey' is true, then this index additionally must not be
* multi-key.
*
* If no such index exists, returns NULL.
*/
IndexDescriptor* findShardKeyPrefixedIndex(OperationContext* txn,
const BSONObj& shardKey,
bool requireSingleKey) const;
void findIndexByType(OperationContext* txn,
const std::string& type,
std::vector<IndexDescriptor*>& matches,
bool includeUnfinishedIndexes = false) const;
/**
* Reload the index definition for 'oldDesc' from the CollectionCatalogEntry. 'oldDesc'
* must be a ready index that is already registered with the index catalog. Returns an
* unowned pointer to the descriptor for the new index definition.
*
* Use this method to notify the IndexCatalog that the spec for this index has changed.
*
* It is invalid to dereference 'oldDesc' after calling this method. This method broadcasts
* an invalidateAll() on the cursor manager to notify other users of the IndexCatalog that
* this descriptor is now invalid.
*/
const IndexDescriptor* refreshEntry(OperationContext* txn, const IndexDescriptor* oldDesc);
// never returns NULL
const IndexCatalogEntry* getEntry(const IndexDescriptor* desc) const;
IndexAccessMethod* getIndex(const IndexDescriptor* desc);
const IndexAccessMethod* getIndex(const IndexDescriptor* desc) const;
/**
* Returns a not-ok Status if there are any unfinished index builds. No new indexes should
* be built when in this state.
*/
Status checkUnfinished() const;
class IndexIterator {
public:
bool more();
IndexDescriptor* next();
// returns the access method for the last return IndexDescriptor
IndexAccessMethod* accessMethod(const IndexDescriptor* desc);
// returns the IndexCatalogEntry for the last return IndexDescriptor
IndexCatalogEntry* catalogEntry(const IndexDescriptor* desc);
private:
IndexIterator(OperationContext* txn,
const IndexCatalog* cat,
bool includeUnfinishedIndexes);
void _advance();
bool _includeUnfinishedIndexes;
OperationContext* const _txn;
const IndexCatalog* _catalog;
IndexCatalogEntryContainer::const_iterator _iterator;
bool _start; // only true before we've called next() or more()
IndexCatalogEntry* _prev;
IndexCatalogEntry* _next;
friend class IndexCatalog;
};
IndexIterator getIndexIterator(OperationContext* txn, bool includeUnfinishedIndexes) const {
return IndexIterator(txn, this, includeUnfinishedIndexes);
};
// ---- index set modifiers ------
/**
* Call this only on an empty collection from inside a WriteUnitOfWork. Index creation on an
* empty collection can be rolled back as part of a larger WUOW.
*/
Status createIndexOnEmptyCollection(OperationContext* txn, BSONObj spec);
StatusWith<BSONObj> prepareSpecForCreate(OperationContext* txn, const BSONObj& original) const;
Status dropAllIndexes(OperationContext* txn, bool includingIdIndex);
Status dropIndex(OperationContext* txn, IndexDescriptor* desc);
/**
* will drop all incompleted indexes and return specs
* after this, the indexes can be rebuilt
*/
std::vector<BSONObj> getAndClearUnfinishedIndexes(OperationContext* txn);
struct IndexKillCriteria {
std::string ns;
std::string name;
BSONObj key;
};
// ---- modify single index
bool isMultikey(OperationContext* txn, const IndexDescriptor* idex);
// --- these probably become private?
/**
* disk creation order
* 1) system.indexes entry
* 2) collection's NamespaceDetails
* a) info + head
* b) _indexBuildsInProgress++
* 3) indexes entry in .ns file
* 4) system.namespaces entry for index ns
*/
class IndexBuildBlock {
MONGO_DISALLOW_COPYING(IndexBuildBlock);
public:
IndexBuildBlock(OperationContext* txn, Collection* collection, const BSONObj& spec);
~IndexBuildBlock();
Status init();
void success();
/**
* index build failed, clean up meta data
*/
void fail();
IndexCatalogEntry* getEntry() {
return _entry;
}
private:
Collection* const _collection;
IndexCatalog* const _catalog;
const std::string _ns;
BSONObj _spec;
std::string _indexName;
std::string _indexNamespace;
IndexCatalogEntry* _entry;
bool _inProgress;
OperationContext* _txn;
};
// ----- data modifiers ------
// this throws for now
Status indexRecords(OperationContext* txn, const std::vector<BsonRecord>& bsonRecords);
void unindexRecord(OperationContext* txn, const BSONObj& obj, const RecordId& loc, bool noWarn);
// ------- temp internal -------
std::string getAccessMethodName(OperationContext* txn, const BSONObj& keyPattern) {
return _getAccessMethodName(txn, keyPattern);
}
Status _upgradeDatabaseMinorVersionIfNeeded(OperationContext* txn,
const std::string& newPluginName);
// public static helpers
static BSONObj fixIndexKey(const BSONObj& key);
private:
static const BSONObj _idObj; // { _id : 1 }
bool _shouldOverridePlugin(OperationContext* txn, const BSONObj& keyPattern) const;
/**
* This differs from IndexNames::findPluginName in that returns the plugin name we *should*
* use, not the plugin name inside of the provided key pattern. To understand when these
* differ, see shouldOverridePlugin.
*/
std::string _getAccessMethodName(OperationContext* txn, const BSONObj& keyPattern) const;
void _checkMagic() const;
Status _indexFilteredRecords(OperationContext* txn,
IndexCatalogEntry* index,
const std::vector<BsonRecord>& bsonRecords);
Status _indexRecords(OperationContext* txn,
IndexCatalogEntry* index,
const std::vector<BsonRecord>& bsonRecords);
Status _unindexRecord(OperationContext* txn,
IndexCatalogEntry* index,
const BSONObj& obj,
const RecordId& loc,
bool logIfError);
/**
* this does no sanity checks
*/
Status _dropIndex(OperationContext* txn, IndexCatalogEntry* entry);
// just does disk hanges
// doesn't change memory state, etc...
void _deleteIndexFromDisk(OperationContext* txn,
const std::string& indexName,
const std::string& indexNamespace);
// descriptor ownership passes to _setupInMemoryStructures
// initFromDisk: Avoids registering a change to undo this operation when set to true.
// You must set this flag if calling this function outside of a UnitOfWork.
IndexCatalogEntry* _setupInMemoryStructures(OperationContext* txn,
IndexDescriptor* descriptor,
bool initFromDisk);
// Apply a set of transformations to the user-provided index object 'spec' to make it
// conform to the standard for insertion. This function adds the 'v' field if it didn't
// exist, removes the '_id' field if it exists, applies plugin-level transformations if
// appropriate, etc.
static BSONObj _fixIndexSpec(const BSONObj& spec);
Status _isSpecOk(OperationContext* txn, const BSONObj& spec) const;
Status _doesSpecConflictWithExisting(OperationContext* txn, const BSONObj& spec) const;
int _magic;
Collection* const _collection;
const int _maxNumIndexesAllowed;
IndexCatalogEntryContainer _entries;
// These are the index specs of indexes that were "leftover".
// "Leftover" means they were unfinished when a mongod shut down.
// Certain operations are prohibited until someone fixes.
// Retrieve by calling getAndClearUnfinishedIndexes().
std::vector<BSONObj> _unfinishedIndexes;
};
}
|