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
|
/**
* Copyright (C) 2017 10gen 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 <memory>
#include <string>
#include "mongo/base/shim.h"
#include "mongo/base/status.h"
#include "mongo/base/string_data.h"
#include "mongo/bson/bsonobj.h"
#include "mongo/db/catalog/collection.h"
#include "mongo/db/catalog/collection_options.h"
#include "mongo/db/namespace_string.h"
#include "mongo/db/repl/optime.h"
#include "mongo/db/storage/storage_options.h"
#include "mongo/db/views/view.h"
#include "mongo/db/views/view_catalog.h"
#include "mongo/stdx/functional.h"
#include "mongo/util/mongoutils/str.h"
#include "mongo/util/string_map.h"
namespace mongo {
/**
* Represents a logical database containing Collections.
*
* The semantics for a const Database are that you can mutate individual collections but not add or
* remove them.
*/
class Database : public Decorable<Database> {
public:
typedef StringMap<Collection*> CollectionMap;
class Impl {
public:
virtual ~Impl() = 0;
virtual void init(OperationContext* opCtx) = 0;
virtual void close(OperationContext* opCtx, const std::string& reason) = 0;
virtual const std::string& name() const = 0;
virtual void clearTmpCollections(OperationContext* opCtx) = 0;
virtual Status setProfilingLevel(OperationContext* opCtx, int newLevel) = 0;
virtual int getProfilingLevel() const = 0;
virtual const char* getProfilingNS() const = 0;
virtual void setDropPending(OperationContext* opCtx, bool dropPending) = 0;
virtual bool isDropPending(OperationContext* opCtx) const = 0;
virtual void getStats(OperationContext* opCtx, BSONObjBuilder* output, double scale) = 0;
virtual const DatabaseCatalogEntry* getDatabaseCatalogEntry() const = 0;
virtual Status dropCollection(OperationContext* opCtx,
StringData fullns,
repl::OpTime dropOpTime) = 0;
virtual Status dropCollectionEvenIfSystem(OperationContext* opCtx,
const NamespaceString& fullns,
repl::OpTime dropOpTime) = 0;
virtual Status dropView(OperationContext* opCtx, StringData fullns) = 0;
virtual Collection* createCollection(OperationContext* opCtx,
StringData ns,
const CollectionOptions& options,
bool createDefaultIndexes,
const BSONObj& idIndex) = 0;
virtual Status createView(OperationContext* opCtx,
StringData viewName,
const CollectionOptions& options) = 0;
virtual Collection* getCollection(OperationContext* opCtx, StringData ns) const = 0;
virtual ViewCatalog* getViewCatalog() = 0;
virtual Collection* getOrCreateCollection(OperationContext* opCtx,
const NamespaceString& nss) = 0;
virtual Status renameCollection(OperationContext* opCtx,
StringData fromNS,
StringData toNS,
bool stayTemp) = 0;
virtual const NamespaceString& getSystemIndexesName() const = 0;
virtual const std::string& getSystemViewsName() const = 0;
virtual StatusWith<NamespaceString> makeUniqueCollectionNamespace(
OperationContext* opCtx, StringData collectionNameModel) = 0;
virtual CollectionMap& collections() = 0;
virtual const CollectionMap& collections() const = 0;
};
public:
static MONGO_DECLARE_SHIM((OperationContext * opCtx)->void) dropAllDatabasesExceptLocal;
/**
* Creates the namespace 'ns' in the database 'db' according to 'options'. If
* 'createDefaultIndexes' is true, creates the _id index for the collection (and the system
* indexes, in the case of system collections). Creates the collection's _id index according
* to 'idIndex', if it is non-empty. When 'idIndex' is empty, creates the default _id index.
*/
static MONGO_DECLARE_SHIM((OperationContext * opCtx,
Database* db,
StringData ns,
CollectionOptions collectionOptions,
bool createDefaultIndexes = true,
const BSONObj& idIndex = BSONObj())
->Status) userCreateNS;
static MONGO_DECLARE_SHIM((Database * this_,
OperationContext* opCtx,
StringData name,
DatabaseCatalogEntry*,
PrivateTo<Database>)
->std::unique_ptr<Impl>) makeImpl;
/**
* Iterating over a Database yields Collection* pointers.
*/
class iterator {
public:
using iterator_category = std::forward_iterator_tag;
using value_type = Collection*;
using pointer = const value_type*;
using reference = const value_type&;
using difference_type = ptrdiff_t;
explicit inline iterator() = default;
inline iterator(CollectionMap::const_iterator it) : _it(std::move(it)) {}
inline reference operator*() const {
return _it->second;
}
inline pointer operator->() const {
return &_it->second;
}
inline friend bool operator==(const iterator& lhs, const iterator& rhs) {
return lhs._it == rhs._it;
}
inline friend bool operator!=(const iterator& lhs, const iterator& rhs) {
return !(lhs == rhs);
}
inline iterator& operator++() {
++_it;
return *this;
}
inline iterator operator++(int) {
auto oldPosition = *this;
++_it;
return oldPosition;
}
private:
CollectionMap::const_iterator _it;
};
explicit inline Database(OperationContext* const opCtx,
const StringData name,
DatabaseCatalogEntry* const dbEntry)
: _pimpl(makeImpl(this, opCtx, name, dbEntry, PrivateCall<Database>{})) {
this->_impl().init(opCtx);
}
// must call close first
inline ~Database() = default;
inline Database(Database&&) = delete;
inline Database& operator=(Database&&) = delete;
inline iterator begin() const {
return iterator(this->_impl().collections().begin());
}
inline iterator end() const {
return iterator(this->_impl().collections().end());
}
// closes files and other cleanup see below.
inline void close(OperationContext* const opCtx, const std::string& reason) {
return this->_impl().close(opCtx, reason);
}
inline const std::string& name() const {
return this->_impl().name();
}
inline void clearTmpCollections(OperationContext* const opCtx) {
return this->_impl().clearTmpCollections(opCtx);
}
/**
* Sets a new profiling level for the database and returns the outcome.
*
* @param opCtx Operation context which to use for creating the profiling collection.
* @param newLevel New profiling level to use.
*/
inline Status setProfilingLevel(OperationContext* const opCtx, const int newLevel) {
return this->_impl().setProfilingLevel(opCtx, newLevel);
}
inline int getProfilingLevel() const {
return this->_impl().getProfilingLevel();
}
inline const char* getProfilingNS() const {
return this->_impl().getProfilingNS();
}
/**
* Sets the 'drop-pending' state of this Database.
* This is done at the beginning of a dropDatabase operation and is used to reject subsequent
* collection creation requests on this database.
* Throws a UserAssertion if this is called on a Database that is already in a 'drop-pending'
* state.
* The database must be locked in MODE_X when calling this function.
*/
inline void setDropPending(OperationContext* opCtx, bool dropPending) {
this->_impl().setDropPending(opCtx, dropPending);
}
/**
* Returns the 'drop-pending' state of this Database.
* The database must be locked in MODE_X when calling this function.
*/
inline bool isDropPending(OperationContext* opCtx) const {
return this->_impl().isDropPending(opCtx);
}
inline void getStats(OperationContext* const opCtx,
BSONObjBuilder* const output,
const double scale = 1) {
return this->_impl().getStats(opCtx, output, scale);
}
inline const DatabaseCatalogEntry* getDatabaseCatalogEntry() const {
return this->_impl().getDatabaseCatalogEntry();
}
/**
* dropCollection() will refuse to drop system collections. Use dropCollectionEvenIfSystem() if
* that is required.
*
* If we are applying a 'drop' oplog entry on a secondary, 'dropOpTime' will contain the optime
* of the oplog entry.
*/
inline Status dropCollection(OperationContext* const opCtx,
const StringData fullns,
repl::OpTime dropOpTime = {}) {
return this->_impl().dropCollection(opCtx, fullns, dropOpTime);
}
inline Status dropCollectionEvenIfSystem(OperationContext* const opCtx,
const NamespaceString& fullns,
repl::OpTime dropOpTime = {}) {
return this->_impl().dropCollectionEvenIfSystem(opCtx, fullns, dropOpTime);
}
inline Status dropView(OperationContext* const opCtx, const StringData fullns) {
return this->_impl().dropView(opCtx, fullns);
}
inline Collection* createCollection(OperationContext* const opCtx,
StringData ns,
const CollectionOptions& options = CollectionOptions(),
const bool createDefaultIndexes = true,
const BSONObj& idIndex = BSONObj()) {
return this->_impl().createCollection(opCtx, ns, options, createDefaultIndexes, idIndex);
}
inline Status createView(OperationContext* const opCtx,
const StringData viewName,
const CollectionOptions& options) {
return this->_impl().createView(opCtx, viewName, options);
}
/**
* @param ns - this is fully qualified, which is maybe not ideal ???
*/
inline Collection* getCollection(OperationContext* opCtx, const StringData ns) const {
return this->_impl().getCollection(opCtx, ns);
}
inline Collection* getCollection(OperationContext* opCtx, const NamespaceString& ns) const {
return this->_impl().getCollection(opCtx, ns.ns());
}
/**
* Get the view catalog, which holds the definition for all views created on this database. You
* must be holding a database lock to use this accessor.
*/
inline ViewCatalog* getViewCatalog() {
return this->_impl().getViewCatalog();
}
inline Collection* getOrCreateCollection(OperationContext* const opCtx,
const NamespaceString& nss) {
return this->_impl().getOrCreateCollection(opCtx, nss);
}
inline Status renameCollection(OperationContext* const opCtx,
const StringData fromNS,
const StringData toNS,
const bool stayTemp) {
return this->_impl().renameCollection(opCtx, fromNS, toNS, stayTemp);
}
/**
* Physically drops the specified opened database and removes it from the server's metadata. It
* doesn't notify the replication subsystem or do any other consistency checks, so it should
* not be used directly from user commands.
*
* Must be called with the specified database locked in X mode.
*/
static MONGO_DECLARE_SHIM((OperationContext * opCtx, Database* db)->void) dropDatabase;
inline const NamespaceString& getSystemIndexesName() const {
return this->_impl().getSystemIndexesName();
}
inline const std::string& getSystemViewsName() const {
return this->_impl().getSystemViewsName();
}
/**
* Generates a collection namespace suitable for creating a temporary collection.
* The namespace is based on a model that replaces each percent sign in 'collectionNameModel' by
* a random character in the range [0-9A-Za-z].
* Returns FailedToParse if 'collectionNameModel' does not contain any percent signs.
* Returns NamespaceExists if we are unable to generate a collection name that does not conflict
* with an existing collection in this database.
*
* The database must be locked in MODE_X when calling this function.
*/
inline StatusWith<NamespaceString> makeUniqueCollectionNamespace(
OperationContext* opCtx, StringData collectionNameModel) {
return this->_impl().makeUniqueCollectionNamespace(opCtx, collectionNameModel);
}
private:
// This structure exists to give us a customization point to decide how to force users of this
// class to depend upon the corresponding `database.cpp` Translation Unit (TU). All public
// forwarding functions call `_impl(), and `_impl` creates an instance of this structure.
struct TUHook {
static void hook() noexcept;
explicit inline TUHook() noexcept {
if (kDebugBuild)
this->hook();
}
};
inline const Impl& _impl() const {
TUHook{};
return *this->_pimpl;
}
inline Impl& _impl() {
TUHook{};
return *this->_pimpl;
}
std::unique_ptr<Impl> _pimpl;
};
} // namespace mongo
|