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
|
/**
* Copyright (C) 2019-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/base/string_data.h"
#include "mongo/db/catalog/collection_catalog_entry.h"
#include "mongo/db/catalog/collection_options.h"
#include "mongo/db/namespace_string.h"
#include "mongo/db/operation_context.h"
#include "mongo/db/storage/bson_collection_catalog_entry.h"
#include "mongo/db/storage/kv/kv_prefix.h"
#include "mongo/db/storage/storage_engine.h"
namespace mongo {
/**
* An interface to modify the on-disk catalog metadata.
*/
class DurableCatalog {
DurableCatalog(const DurableCatalog&) = delete;
DurableCatalog& operator=(const DurableCatalog&) = delete;
DurableCatalog(DurableCatalog&&) = delete;
DurableCatalog& operator=(DurableCatalog&&) = delete;
protected:
DurableCatalog() = default;
public:
virtual ~DurableCatalog() {}
static DurableCatalog* get(OperationContext* opCtx) {
return opCtx->getServiceContext()->getStorageEngine()->getCatalog();
}
virtual void init(OperationContext* opCtx) = 0;
virtual std::vector<NamespaceString> getAllCollections() const = 0;
virtual std::string getCollectionIdent(const NamespaceString& nss) const = 0;
virtual std::string getIndexIdent(OperationContext* opCtx,
const NamespaceString& nss,
StringData idName) const = 0;
virtual BSONCollectionCatalogEntry::MetaData getMetaData(OperationContext* opCtx,
const NamespaceString& nss) const = 0;
virtual void putMetaData(OperationContext* opCtx,
const NamespaceString& nss,
BSONCollectionCatalogEntry::MetaData& md) = 0;
virtual std::vector<std::string> getAllIdentsForDB(StringData db) const = 0;
virtual std::vector<std::string> getAllIdents(OperationContext* opCtx) const = 0;
virtual bool isUserDataIdent(StringData ident) const = 0;
virtual bool isInternalIdent(StringData ident) const = 0;
virtual bool isCollectionIdent(StringData ident) const = 0;
virtual RecordStore* getRecordStore() = 0;
/**
* Create an entry in the catalog for an orphaned collection found in the
* storage engine. Return the generated ns of the collection.
* Note that this function does not recreate the _id index on the collection because it does not
* have access to index catalog.
*/
virtual StatusWith<std::string> newOrphanedIdent(OperationContext* opCtx,
std::string ident) = 0;
virtual std::string getFilesystemPathForDb(const std::string& dbName) const = 0;
/**
* Generate an internal ident name.
*/
virtual std::string newInternalIdent() = 0;
virtual std::unique_ptr<CollectionCatalogEntry> makeCollectionCatalogEntry(
OperationContext* opCtx, const NamespaceString& nss, bool forRepair) = 0;
virtual StatusWith<std::unique_ptr<CollectionCatalogEntry>> createCollection(
OperationContext* opCtx,
const NamespaceString& nss,
const CollectionOptions& options,
bool allocateDefaultSpace) = 0;
virtual Status renameCollection(OperationContext* opCtx,
const NamespaceString& fromNss,
const NamespaceString& toNss,
bool stayTemp) = 0;
virtual Status dropCollection(OperationContext* opCtx, const NamespaceString& nss) = 0;
/**
* Updates size of a capped Collection.
*/
virtual void updateCappedSize(OperationContext* opCtx, NamespaceString ns, long long size) = 0;
/*
* Updates the expireAfterSeconds field of the given index to the value in newExpireSecs.
* The specified index must already contain an expireAfterSeconds field, and the value in
* that field and newExpireSecs must both be numeric.
*/
virtual void updateTTLSetting(OperationContext* opCtx,
NamespaceString ns,
StringData idxName,
long long newExpireSeconds) = 0;
/**
* Compare the UUID argument to the UUID obtained from the metadata. Return true if they
* are equal, false otherwise. uuid can become a CollectionUUID once MMAPv1 is removed.
*/
virtual bool isEqualToMetadataUUID(OperationContext* opCtx,
NamespaceString ns,
OptionalCollectionUUID uuid) = 0;
/**
* Updates the 'temp' setting for this collection.
*/
virtual void setIsTemp(OperationContext* opCtx, NamespaceString ns, bool isTemp) = 0;
virtual boost::optional<std::string> getSideWritesIdent(OperationContext* opCtx,
NamespaceString ns,
StringData indexName) const = 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* opCtx) = 0;
/**
* Updates the validator for this collection.
*
* An empty validator removes all validation.
*/
virtual void updateValidator(OperationContext* opCtx,
NamespaceString ns,
const BSONObj& validator,
StringData validationLevel,
StringData validationAction) = 0;
virtual void updateIndexMetadata(OperationContext* opCtx,
NamespaceString ns,
const IndexDescriptor* desc) = 0;
virtual Status removeIndex(OperationContext* opCtx,
NamespaceString ns,
StringData indexName) = 0;
virtual Status prepareForIndexBuild(OperationContext* opCtx,
NamespaceString ns,
const IndexDescriptor* spec,
IndexBuildProtocol indexBuildProtocol,
bool isBackgroundSecondaryBuild) = 0;
/**
* Returns whether or not the index is being built with the two-phase index build procedure.
*/
virtual bool isTwoPhaseIndexBuild(OperationContext* opCtx,
NamespaceString ns,
StringData indexName) const = 0;
/**
* Indicate that a build index is now in the "scanning" phase of a hybrid index build. The
* 'constraintViolationsIdent' is only used for unique indexes.
*
* It is only valid to call this when the index is using the kTwoPhase IndexBuildProtocol.
*/
virtual void setIndexBuildScanning(OperationContext* opCtx,
NamespaceString ns,
StringData indexName,
std::string sideWritesIdent,
boost::optional<std::string> constraintViolationsIdent) = 0;
/**
* Returns whether or not this index is building in the "scanning" phase.
*/
virtual bool isIndexBuildScanning(OperationContext* opCtx,
NamespaceString ns,
StringData indexName) const = 0;
/**
* Indicate that a build index is now in the "draining" phase of a hybrid index build.
*
* It is only valid to call this when the index is using the kTwoPhase IndexBuildProtocol.
*/
virtual void setIndexBuildDraining(OperationContext* opCtx,
NamespaceString ns,
StringData indexName) = 0;
/**
* Returns whether or not this index is building in the "draining" phase.
*/
virtual bool isIndexBuildDraining(OperationContext* opCtx,
NamespaceString ns,
StringData indexName) const = 0;
/**
* Indicate that an index build is completed and the index is ready to use.
*/
virtual void indexBuildSuccess(OperationContext* opCtx,
NamespaceString ns,
StringData indexName) = 0;
/**
* Returns true if the index identified by 'indexName' is multikey, and returns false otherwise.
*
* If the 'multikeyPaths' pointer is non-null, then it must point to an empty vector. If this
* index supports tracking path-level multikey information, then this function sets
* 'multikeyPaths' as the path components that cause this index to be multikey.
*
* In particular, if this function returns false and the index supports tracking path-level
* multikey information, then 'multikeyPaths' is initialized as a vector with size equal to the
* number of elements in the index key pattern of empty sets.
*/
virtual bool isIndexMultikey(OperationContext* opCtx,
NamespaceString ns,
StringData indexName,
MultikeyPaths* multikeyPaths) const = 0;
/**
* Sets the index identified by 'indexName' to be multikey.
*
* If 'multikeyPaths' is non-empty, then it 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.
*
* This function returns true if the index metadata has changed, and returns false otherwise.
*/
virtual bool setIndexIsMultikey(OperationContext* opCtx,
NamespaceString ns,
StringData indexName,
const MultikeyPaths& multikeyPaths) = 0;
virtual boost::optional<std::string> getConstraintViolationsIdent(
OperationContext* opCtx, NamespaceString ns, StringData indexName) const = 0;
/**
* Returns the server-compatibility version of the index build procedure.
*/
virtual long getIndexBuildVersion(OperationContext* opCtx,
NamespaceString ns,
StringData indexName) const = 0;
virtual CollectionOptions getCollectionOptions(OperationContext* opCtx,
NamespaceString ns) const = 0;
virtual int getTotalIndexCount(OperationContext* opCtx, NamespaceString ns) const = 0;
virtual int getCompletedIndexCount(OperationContext* opCtx, NamespaceString ns) const = 0;
virtual BSONObj getIndexSpec(OperationContext* opCtx,
NamespaceString ns,
StringData indexName) const = 0;
virtual void getAllIndexes(OperationContext* opCtx,
NamespaceString ns,
std::vector<std::string>* names) const = 0;
virtual void getReadyIndexes(OperationContext* opCtx,
NamespaceString ns,
std::vector<std::string>* names) const = 0;
virtual void getAllUniqueIndexes(OperationContext* opCtx,
NamespaceString ns,
std::vector<std::string>* names) const = 0;
virtual bool isIndexPresent(OperationContext* opCtx,
NamespaceString ns,
StringData indexName) const = 0;
virtual bool isIndexReady(OperationContext* opCtx,
NamespaceString ns,
StringData indexName) const = 0;
virtual KVPrefix getIndexPrefix(OperationContext* opCtx,
NamespaceString ns,
StringData indexName) const = 0;
};
} // namespace mongo
|
