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
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
|
/**
* 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 "mongo/bson/timestamp.h"
#include "mongo/db/catalog/collection.h"
#include "mongo/db/catalog/collection_catalog_entry.h"
#include "mongo/db/catalog/index_catalog.h"
#include "mongo/db/concurrency/d_concurrency.h"
namespace mongo {
class IndexConsistency;
class UUIDCatalog;
class CollectionImpl final : virtual public Collection::Impl, virtual CappedCallback {
private:
static const int kMagicNumber = 1357924;
public:
explicit CollectionImpl(Collection* _this,
OperationContext* opCtx,
StringData fullNS,
OptionalCollectionUUID uuid,
CollectionCatalogEntry* details, // does not own
RecordStore* recordStore, // does not own
DatabaseCatalogEntry* dbce); // does not own
~CollectionImpl();
void init(OperationContext* opCtx) final;
bool ok() const final {
return _magic == kMagicNumber;
}
CollectionCatalogEntry* getCatalogEntry() final {
return _details;
}
const CollectionCatalogEntry* getCatalogEntry() const final {
return _details;
}
CollectionInfoCache* infoCache() final {
return &_infoCache;
}
const CollectionInfoCache* infoCache() const final {
return &_infoCache;
}
const NamespaceString& ns() const final {
return _ns;
}
void setNs(NamespaceString nss) final;
OptionalCollectionUUID uuid() const {
return _uuid;
}
const IndexCatalog* getIndexCatalog() const final {
return _indexCatalog.get();
}
IndexCatalog* getIndexCatalog() final {
return _indexCatalog.get();
}
const RecordStore* getRecordStore() const final {
return _recordStore;
}
RecordStore* getRecordStore() final {
return _recordStore;
}
CursorManager* getCursorManager() const final {
return _cursorManager.get();
}
bool requiresIdIndex() const final;
Snapshotted<BSONObj> docFor(OperationContext* opCtx, const RecordId& loc) const final {
return Snapshotted<BSONObj>(opCtx->recoveryUnit()->getSnapshotId(),
_recordStore->dataFor(opCtx, loc).releaseToBson());
}
/**
* @param out - contents set to the right docs if exists, or nothing.
* @return true iff loc exists
*/
bool findDoc(OperationContext* opCtx,
const RecordId& loc,
Snapshotted<BSONObj>* out) const final;
std::unique_ptr<SeekableRecordCursor> getCursor(OperationContext* opCtx,
bool forward = true) const final;
/**
* Deletes the document with the given RecordId from the collection.
*
* 'stmtId' the statement id for this delete operation. Pass in kUninitializedStmtId if not
* applicable.
* 'fromMigrate' indicates whether the delete was induced by a chunk migration, and
* so should be ignored by the user as an internal maintenance operation and not a
* real delete.
* 'loc' key to uniquely identify a record in a collection.
* 'opDebug' Optional argument. When not null, will be used to record operation statistics.
* 'cappedOK' if true, allows deletes on capped collections (Cloner::copyDB uses this).
* 'noWarn' if unindexing the record causes an error, if noWarn is true the error
* will not be logged.
* 'storeDeletedDoc' whether to store the document deleted in the oplog.
*/
void deleteDocument(
OperationContext* opCtx,
StmtId stmtId,
const RecordId& loc,
OpDebug* opDebug,
bool fromMigrate = false,
bool noWarn = false,
Collection::StoreDeletedDoc storeDeletedDoc = Collection::StoreDeletedDoc::Off) final;
/*
* Inserts all documents inside one WUOW.
* Caller should ensure vector is appropriately sized for this.
* If any errors occur (including WCE), caller should retry documents individually.
*
* 'opDebug' Optional argument. When not null, will be used to record operation statistics.
*/
Status insertDocuments(OperationContext* opCtx,
std::vector<InsertStatement>::const_iterator begin,
std::vector<InsertStatement>::const_iterator end,
OpDebug* opDebug,
bool fromMigrate = false) final;
/**
* this does NOT modify the doc before inserting
* i.e. will not add an _id field for documents that are missing it
*
* 'opDebug' Optional argument. When not null, will be used to record operation statistics.
*/
Status insertDocument(OperationContext* opCtx,
const InsertStatement& doc,
OpDebug* opDebug,
bool fromMigrate = false) final;
/**
* Callers must ensure no document validation is performed for this collection when calling
* this method.
*/
Status insertDocumentsForOplog(OperationContext* opCtx,
const DocWriter* const* docs,
Timestamp* timestamps,
size_t nDocs) final;
/**
* Inserts a document into the record store for a bulk loader that manages the index building
* outside this Collection. The bulk loader is notified with the RecordId of the document
* inserted into the RecordStore.
*
* NOTE: It is up to caller to commit the indexes.
*/
Status insertDocumentForBulkLoader(OperationContext* opCtx,
const BSONObj& doc,
const OnRecordInsertedFn& onRecordInserted) final;
/**
* Updates the document @ oldLocation with newDoc.
*
* If the document fits in the old space, it is put there; if not, it is moved.
* Sets 'args.updatedDoc' to the updated version of the document with damages applied, on
* success.
* 'opDebug' Optional argument. When not null, will be used to record operation statistics.
* @return the post update location of the doc (may or may not be the same as oldLocation)
*/
RecordId updateDocument(OperationContext* opCtx,
const RecordId& oldLocation,
const Snapshotted<BSONObj>& oldDoc,
const BSONObj& newDoc,
bool indexesAffected,
OpDebug* opDebug,
CollectionUpdateArgs* args) final;
bool updateWithDamagesSupported() const final;
/**
* Not allowed to modify indexes.
* Illegal to call if updateWithDamagesSupported() returns false.
* Sets 'args.updatedDoc' to the updated version of the document with damages applied, on
* success.
* @return the contents of the updated record.
*/
StatusWith<RecordData> updateDocumentWithDamages(OperationContext* opCtx,
const RecordId& loc,
const Snapshotted<RecordData>& oldRec,
const char* damageSource,
const mutablebson::DamageVector& damages,
CollectionUpdateArgs* args) final;
// -----------
/**
* removes all documents as fast as possible
* indexes before and after will be the same
* as will other characteristics
*/
Status truncate(OperationContext* opCtx) final;
/**
* @return OK if the validate run successfully
* OK will be returned even if corruption is found
* deatils will be in result
*/
Status validate(OperationContext* opCtx,
ValidateCmdLevel level,
bool background,
std::unique_ptr<Lock::CollectionLock> collLk,
ValidateResults* results,
BSONObjBuilder* output) final;
/**
* forces data into cache
*/
Status touch(OperationContext* opCtx,
bool touchData,
bool touchIndexes,
BSONObjBuilder* output) const final;
/**
* Truncate documents newer than the document at 'end' from the capped
* collection. The collection cannot be completely emptied using this
* function. An assertion will be thrown if that is attempted.
* @param inclusive - Truncate 'end' as well iff true
*/
void cappedTruncateAfter(OperationContext* opCtx, RecordId end, bool inclusive) final;
using ValidationAction = Collection::ValidationAction;
using ValidationLevel = Collection::ValidationLevel;
/**
* Returns a non-ok Status if validator is not legal for this collection.
*/
StatusWithMatchExpression parseValidator(
OperationContext* opCtx,
const BSONObj& validator,
MatchExpressionParser::AllowedFeatureSet allowedFeatures,
boost::optional<ServerGlobalParams::FeatureCompatibility::Version>
maxFeatureCompatibilityVersion = boost::none) const final;
static StatusWith<ValidationLevel> parseValidationLevel(StringData);
static StatusWith<ValidationAction> parseValidationAction(StringData);
/**
* Sets the validator for this collection.
*
* An empty validator removes all validation.
* Requires an exclusive lock on the collection.
*/
Status setValidator(OperationContext* opCtx, BSONObj validator) final;
Status setValidationLevel(OperationContext* opCtx, StringData newLevel) final;
Status setValidationAction(OperationContext* opCtx, StringData newAction) final;
StringData getValidationLevel() const final;
StringData getValidationAction() const final;
/**
* Sets the validator to exactly what's provided. If newLevel or newAction are empty, this
* sets them to the defaults. Any error Status returned by this function should be considered
* fatal.
*/
Status updateValidator(OperationContext* opCtx,
BSONObj newValidator,
StringData newLevel,
StringData newAction) final;
// -----------
//
// Stats
//
bool isCapped() const final;
/**
* Get a pointer to a capped insert notifier object. The caller can wait on this object
* until it is notified of a new insert into the capped collection.
*
* It is invalid to call this method unless the collection is capped.
*/
std::shared_ptr<CappedInsertNotifier> getCappedInsertNotifier() const final;
uint64_t numRecords(OperationContext* opCtx) const final;
uint64_t dataSize(OperationContext* opCtx) const final;
inline int averageObjectSize(OperationContext* opCtx) const {
uint64_t n = numRecords(opCtx);
if (n == 0)
return 5;
return static_cast<int>(dataSize(opCtx) / n);
}
uint64_t getIndexSize(OperationContext* opCtx,
BSONObjBuilder* details = NULL,
int scale = 1) final;
/**
* If return value is not boost::none, reads with majority read concern using an older snapshot
* must error.
*/
boost::optional<Timestamp> getMinimumVisibleSnapshot() final {
return _minVisibleSnapshot;
}
void setMinimumVisibleSnapshot(Timestamp name) final {
_minVisibleSnapshot = name;
}
bool haveCappedWaiters() final;
/**
* Notify (capped collection) waiters of data changes, like an insert.
*/
void notifyCappedWaitersIfNeeded() final;
/**
* Get a pointer to the collection's default collator. The pointer must not be used after this
* Collection is destroyed.
*/
const CollatorInterface* getDefaultCollator() const final;
std::unique_ptr<PlanExecutor, PlanExecutor::Deleter> makePlanExecutor(
OperationContext* opCtx,
PlanExecutor::YieldPolicy yieldPolicy,
ScanDirection scanDirection) final;
void indexBuildSuccess(OperationContext* opCtx, IndexCatalogEntry* index) final;
private:
inline DatabaseCatalogEntry* dbce() const final {
return this->_dbce;
}
inline CollectionCatalogEntry* details() const final {
return this->_details;
}
/**
* Returns a non-ok Status if document does not pass this collection's validator.
*/
Status checkValidation(OperationContext* opCtx, const BSONObj& document) const;
Status aboutToDeleteCapped(OperationContext* opCtx, const RecordId& loc, RecordData data);
/**
* same semantics as insertDocument, but doesn't do:
* - some user error checks
* - adjust padding
*/
Status _insertDocument(OperationContext* opCtx, const BSONObj& doc);
Status _insertDocuments(OperationContext* opCtx,
std::vector<InsertStatement>::const_iterator begin,
std::vector<InsertStatement>::const_iterator end,
OpDebug* opDebug);
int _magic;
NamespaceString _ns;
OptionalCollectionUUID _uuid;
CollectionCatalogEntry* const _details;
RecordStore* const _recordStore;
DatabaseCatalogEntry* const _dbce;
const bool _needCappedLock;
CollectionInfoCache _infoCache;
std::unique_ptr<IndexCatalog> _indexCatalog;
// The default collation which is applied to operations and indices which have no collation of
// their own. The collection's validator will respect this collation.
//
// If null, the default collation is simple binary compare.
std::unique_ptr<CollatorInterface> _collator;
// Empty means no filter.
BSONObj _validatorDoc;
// Points into _validatorDoc. Null means no filter.
std::unique_ptr<MatchExpression> _validator;
ValidationAction _validationAction;
ValidationLevel _validationLevel;
std::unique_ptr<CursorManager> _cursorManager;
// Notifier object for awaitData. Threads polling a capped collection for new data can wait
// on this object until notified of the arrival of new data.
//
// This is non-null if and only if the collection is a capped collection.
const std::shared_ptr<CappedInsertNotifier> _cappedNotifier;
// The earliest snapshot that is allowed to use this collection.
boost::optional<Timestamp> _minVisibleSnapshot;
Collection* _this;
};
} // namespace mongo
|