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
|
/**
* 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 <memory>
#include <string>
#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_catalog.h"
#include "mongo/db/catalog/collection_options.h"
#include "mongo/db/database_name.h"
#include "mongo/db/namespace_string.h"
#include "mongo/db/repl/optime.h"
#include "mongo/util/string_map.h"
namespace mongo {
class OperationContext;
/**
* 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:
/**
* 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.
*/
virtual Status userCreateNS(OperationContext* opCtx,
const NamespaceString& fullns,
CollectionOptions collectionOptions,
bool createDefaultIndexes = true,
const BSONObj& idIndex = BSONObj(),
bool fromMigrate = false) const = 0;
Database() = default;
// must call close first
virtual ~Database() = default;
inline Database(Database&&) = delete;
inline Database& operator=(Database&&) = delete;
/**
* Sets up internal memory structures.
*/
virtual Status init(OperationContext* opCtx) = 0;
virtual const DatabaseName& name() const = 0;
virtual void clearTmpCollections(OperationContext* opCtx) const = 0;
/**
* 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.
* The database must be locked in MODE_X when calling this function.
*/
virtual void setDropPending(OperationContext* opCtx, bool dropPending) = 0;
/**
* Returns the 'drop-pending' state of this Database.
*/
virtual bool isDropPending(OperationContext* opCtx) const = 0;
virtual void getStats(OperationContext* opCtx,
BSONObjBuilder* output,
bool includeFreeStorage,
double scale = 1) const = 0;
/**
* 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.
*
* The caller should hold a DB X lock and ensure there are no index builds in progress on the
* collection.
* N.B. Namespace argument is passed by value as it may otherwise disappear or change.
*/
virtual Status dropCollection(OperationContext* opCtx,
NamespaceString nss,
repl::OpTime dropOpTime = {}) const = 0;
virtual Status dropCollectionEvenIfSystem(OperationContext* opCtx,
NamespaceString nss,
repl::OpTime dropOpTime = {},
bool markFromMigrate = false) const = 0;
virtual Status dropView(OperationContext* opCtx, NamespaceString viewName) const = 0;
/**
* A MODE_IX collection lock must be held for this call. Throws a WriteConflictException error
* if the collection already exists (say if another thread raced to create it).
*
* Surrounding writeConflictRetry loops must encompass checking that the collection exists as
* well as creating it. Otherwise the loop will endlessly throw WCEs: the caller must check that
* the collection exists to break free.
*/
virtual Collection* createCollection(OperationContext* opCtx,
const NamespaceString& nss,
const CollectionOptions& options = CollectionOptions(),
bool createDefaultIndexes = true,
const BSONObj& idIndex = BSONObj(),
bool fromMigrate = false) const = 0;
virtual Status createView(OperationContext* opCtx,
const NamespaceString& viewName,
const CollectionOptions& options) const = 0;
/**
* Arguments are passed by value as they otherwise would be changing as result of renaming.
*/
virtual Status renameCollection(OperationContext* opCtx,
NamespaceString fromNss,
NamespaceString toNss,
bool stayTemp) const = 0;
virtual const NamespaceString& getSystemViewsName() const = 0;
/**
* 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_IX when calling this function.
*/
virtual StatusWith<NamespaceString> makeUniqueCollectionNamespace(
OperationContext* opCtx, StringData collectionNameModel) const = 0;
/**
* If we are in a replset, every replicated collection must have an _id index. As we scan each
* database, we also gather a list of drop-pending collection namespaces for the
* DropPendingCollectionReaper to clean up eventually.
*/
virtual void checkForIdIndexesAndDropPendingCollections(OperationContext* opCtx) const = 0;
};
} // namespace mongo
|
