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
|
// collection_catalog_entry.h
/**
* Copyright (C) 2014 MongoDB 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 "mongo/base/string_data.h"
#include "mongo/db/catalog/collection_options.h"
#include "mongo/db/index/multikey_paths.h"
#include "mongo/db/namespace_string.h"
#include "mongo/db/record_id.h"
#include "mongo/db/server_options.h"
#include "mongo/db/storage/kv/kv_prefix.h"
namespace mongo {
class Collection;
class IndexDescriptor;
class OperationContext;
class CollectionCatalogEntry {
public:
CollectionCatalogEntry(StringData ns) : _ns(ns) {}
virtual ~CollectionCatalogEntry() {}
const NamespaceString& ns() const {
return _ns;
}
// ------- indexes ----------
virtual CollectionOptions getCollectionOptions(OperationContext* opCtx) const = 0;
virtual int getTotalIndexCount(OperationContext* opCtx) const = 0;
virtual int getCompletedIndexCount(OperationContext* opCtx) const = 0;
virtual int getMaxAllowedIndexes() const = 0;
virtual void getAllIndexes(OperationContext* opCtx, std::vector<std::string>* names) const = 0;
virtual void getReadyIndexes(OperationContext* opCtx,
std::vector<std::string>* names) const = 0;
virtual void getAllUniqueIndexes(OperationContext* opCtx,
std::vector<std::string>* names) const {}
virtual BSONObj getIndexSpec(OperationContext* opCtx, StringData idxName) 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 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,
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,
StringData indexName,
const MultikeyPaths& multikeyPaths) = 0;
virtual RecordId getIndexHead(OperationContext* opCtx, StringData indexName) const = 0;
virtual void setIndexHead(OperationContext* opCtx,
StringData indexName,
const RecordId& newHead) = 0;
virtual bool isIndexReady(OperationContext* opCtx, StringData indexName) const = 0;
virtual bool isIndexPresent(OperationContext* opCtx, StringData indexName) const = 0;
virtual KVPrefix getIndexPrefix(OperationContext* opCtx, StringData indexName) const = 0;
virtual Status removeIndex(OperationContext* opCtx, StringData indexName) = 0;
virtual Status prepareForIndexBuild(OperationContext* opCtx,
const IndexDescriptor* spec,
bool isBackgroundSecondaryBuild) = 0;
virtual void indexBuildSuccess(OperationContext* opCtx, StringData indexName) = 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,
StringData idxName,
long long newExpireSeconds) = 0;
virtual void updateIndexMetadata(OperationContext* opCtx, const IndexDescriptor* desc) {}
/**
* Sets the flags field of CollectionOptions to newValue.
* Subsequent calls to getCollectionOptions should have flags==newValue and flagsSet==true.
*/
virtual void updateFlags(OperationContext* opCtx, int newValue) = 0;
/**
* Updates the validator for this collection.
*
* An empty validator removes all validation.
*/
virtual void updateValidator(OperationContext* opCtx,
const BSONObj& validator,
StringData validationLevel,
StringData validationAction) = 0;
/**
* Updates the 'temp' setting for this collection.
*/
virtual void setIsTemp(OperationContext* opCtx, bool isTemp) = 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, OptionalCollectionUUID uuid) = 0;
/**
* Updates size of a capped Collection.
*/
virtual void updateCappedSize(OperationContext* opCtx, long long size) = 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;
private:
NamespaceString _ns;
};
}
|
