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
|
/**
* 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_options.h"
#include "mongo/db/catalog/import_options.h"
#include "mongo/db/index/index_descriptor.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/storage_engine.h"
#include "mongo/db/tenant_namespace.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:
static constexpr auto kIsFeatureDocumentFieldName = "isFeatureDoc"_sd;
/**
* `Entry` ties together the common identifiers of a single `_mdb_catalog` document.
*/
struct Entry {
Entry() {}
Entry(RecordId catalogId, std::string ident, TenantNamespace tenantNs)
: catalogId(catalogId), ident(std::move(ident)), tenantNs(std::move(tenantNs)) {}
RecordId catalogId;
std::string ident;
TenantNamespace tenantNs;
};
virtual ~DurableCatalog() {}
static DurableCatalog* get(OperationContext* opCtx) {
return opCtx->getServiceContext()->getStorageEngine()->getCatalog();
}
/**
* Allows featureDocuments to be checked with older versions.
*/
static bool isFeatureDocument(const BSONObj& obj) {
BSONElement firstElem = obj.firstElement();
if (firstElem.fieldNameStringData() == kIsFeatureDocumentFieldName) {
return firstElem.booleanSafe();
}
return false;
}
virtual void init(OperationContext* opCtx) = 0;
virtual std::vector<Entry> getAllCatalogEntries(OperationContext* opCtx) const = 0;
virtual Entry getEntry(RecordId catalogId) const = 0;
virtual std::string getIndexIdent(OperationContext* opCtx,
RecordId id,
StringData idxName) const = 0;
virtual std::vector<std::string> getIndexIdents(OperationContext* opCtx, RecordId id) const = 0;
virtual bool isIndexInEntry(OperationContext* opCtx,
RecordId id,
StringData idxIdent) const = 0;
virtual BSONObj getCatalogEntry(OperationContext* opCtx, RecordId catalogId) const = 0;
virtual std::shared_ptr<BSONCollectionCatalogEntry::MetaData> getMetaData(
OperationContext* opCtx, RecordId id) const = 0;
/**
* Updates the catalog entry for the collection 'tenantNs' with the fields specified in 'md'. If
* 'md.indexes' contains a new index entry, then this method generates a new index ident and
* adds it to the catalog entry.
*/
virtual void putMetaData(OperationContext* opCtx,
RecordId id,
BSONCollectionCatalogEntry::MetaData& md) = 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;
/**
* Generate an internal resumable index build ident name.
*/
virtual std::string newInternalResumableIndexBuildIdent() = 0;
/**
* On success, returns the RecordId which identifies the new record store in the durable catalog
* in addition to ownership of the new RecordStore.
*/
virtual StatusWith<std::pair<RecordId, std::unique_ptr<RecordStore>>> createCollection(
OperationContext* opCtx,
const TenantNamespace& tenantNs,
const CollectionOptions& options,
bool allocateDefaultSpace) = 0;
virtual Status createIndex(OperationContext* opCtx,
RecordId catalogId,
const CollectionOptions& collOptions,
const IndexDescriptor* spec) = 0;
/**
* Import a collection by inserting the given metadata into the durable catalog and instructing
* the storage engine to import the corresponding idents. The metadata object should be a valid
* catalog entry and contain the following fields:
* "md": A document representing the BSONCollectionCatalogEntry::MetaData of the collection.
* "idxIdent": A document containing {<index_name>: <index_ident>} pairs for all indexes.
* "tenantNs": TenantNamespace of the collection being imported.
* "ident": Ident of the collection file.
*
* On success, returns an ImportResult structure containing the RecordId which identifies the
* new record store in the durable catalog, ownership of the new RecordStore and the UUID of the
* collection imported.
*
* The collection must be locked in MODE_X when calling this function.
*/
struct ImportResult {
ImportResult(RecordId catalogId, std::unique_ptr<RecordStore> rs, UUID uuid)
: catalogId(catalogId), rs(std::move(rs)), uuid(uuid) {}
RecordId catalogId;
std::unique_ptr<RecordStore> rs;
UUID uuid;
};
virtual StatusWith<ImportResult> importCollection(OperationContext* opCtx,
const TenantNamespace& tenantNs,
const BSONObj& metadata,
const BSONObj& storageMetadata,
const ImportOptions& importOptions) = 0;
virtual Status renameCollection(OperationContext* opCtx,
RecordId catalogId,
const TenantNamespace& toTenantNs,
BSONCollectionCatalogEntry::MetaData& md) = 0;
/**
* Deletes the persisted collection catalog entry identified by 'catalogId'.
*
* Expects (invariants) that all of the index catalog entries have been removed already via
* removeIndex.
*/
virtual Status dropCollection(OperationContext* opCtx, RecordId catalogId) = 0;
/**
* Drops the provided ident and recreates it as empty for use in resuming an index build.
*/
virtual Status dropAndRecreateIndexIdentForResume(OperationContext* opCtx,
const CollectionOptions& collOptions,
const IndexDescriptor* spec,
StringData ident) = 0;
virtual int getTotalIndexCount(OperationContext* opCtx, RecordId catalogId) const = 0;
virtual bool isIndexPresent(OperationContext* opCtx,
RecordId catalogId,
StringData indexName) const = 0;
virtual bool isIndexReady(OperationContext* opCtx,
RecordId catalogId,
StringData indexName) const = 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 type supports tracking path-level multikey information in the catalog, 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,
RecordId catalogId,
StringData indexName,
MultikeyPaths* multikeyPaths) const = 0;
virtual void setRand_forTest(const std::string& rand) = 0;
virtual std::string getRand_forTest() const = 0;
};
} // namespace mongo
|
