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
|
/**
* 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 <boost/shared_ptr.hpp>
#include <wiredtiger.h>
#include "mongo/base/status_with.h"
#include "mongo/db/storage/index_entry_comparison.h"
#include "mongo/db/storage/sorted_data_interface.h"
#include "mongo/db/storage/wiredtiger/wiredtiger_recovery_unit.h"
namespace mongo {
class IndexCatalogEntry;
class IndexDescriptor;
struct WiredTigerItem;
class WiredTigerIndex : public SortedDataInterface {
public:
/**
* Parses index options for wired tiger configuration string suitable for table creation.
* The document 'options' is typically obtained from the 'storageEngine.wiredTiger' field
* of an IndexDescriptor's info object.
*/
static StatusWith<std::string> parseIndexOptions(const BSONObj& options);
/**
* Creates a configuration string suitable for 'config' parameter in WT_SESSION::create().
* Configuration string is constructed from:
* built-in defaults
* 'extraConfig'
* storageEngine.wiredTiger.configString in index descriptor's info object.
* Performs simple validation on the supplied parameters.
* Returns error status if validation fails.
* Note that even if this function returns an OK status, WT_SESSION:create() may still
* fail with the constructed configuration string.
*/
static StatusWith<std::string> generateCreateString(const std::string& extraConfig,
const IndexDescriptor& desc);
/**
* Creates a WiredTiger table suitable for implementing a MongoDB index.
* 'config' should be created with generateCreateString().
*/
static int Create(OperationContext* txn,
const std::string& uri,
const std::string& config);
/**
* @param unique - If this is a unique index.
* Note: even if unique, it may be allowed ot be non-unique at times.
*/
WiredTigerIndex(OperationContext* ctx,
const std::string& uri,
const IndexDescriptor* desc);
virtual SortedDataBuilderInterface* getBulkBuilder(OperationContext* txn, bool dupsAllowed);
virtual Status insert(OperationContext* txn,
const BSONObj& key,
const RecordId& loc,
bool dupsAllowed);
virtual void unindex(OperationContext* txn,
const BSONObj& key,
const RecordId& loc,
bool dupsAllowed);
virtual void fullValidate(OperationContext* txn, bool full, long long *numKeysOut,
BSONObjBuilder* output) const;
virtual bool appendCustomStats(OperationContext* txn, BSONObjBuilder* output, double scale)
const;
virtual Status dupKeyCheck(OperationContext* txn, const BSONObj& key, const RecordId& loc);
virtual bool isEmpty(OperationContext* txn);
virtual long long getSpaceUsedBytes( OperationContext* txn ) const;
bool isDup(WT_CURSOR *c, const BSONObj& key, const RecordId& loc );
virtual SortedDataInterface::Cursor* newCursor(
OperationContext* txn, int direction) const;
virtual Status initAsEmpty(OperationContext* txn);
const std::string& uri() const { return _uri; }
uint64_t instanceId() const { return _instanceId; }
virtual bool unique() const = 0;
protected:
virtual Status _insert( WT_CURSOR* c,
const BSONObj& key,
const RecordId& loc,
bool dupsAllowed ) = 0;
virtual void _unindex( WT_CURSOR* c,
const BSONObj& key,
const RecordId& loc,
bool dupsAllowed ) = 0;
class BulkBuilder;
class StandardBulkBuilder;
class UniqueBulkBuilder;
class IndexCursor : public SortedDataInterface::Cursor {
public:
IndexCursor(const WiredTigerIndex& idx,
OperationContext *txn,
bool forward);
virtual ~IndexCursor() { }
virtual int getDirection() const { return _forward ? 1 : -1; }
virtual bool isEOF() const { return _eof; }
virtual bool pointsToSamePlaceAs(const SortedDataInterface::Cursor &genother) const;
virtual void aboutToDeleteBucket(const RecordId& bucket);
virtual bool locate(const BSONObj &key, const RecordId& loc);
virtual void customLocate(const BSONObj& keyBegin,
int keyBeginLen,
bool afterKey,
const vector<const BSONElement*>& keyEnd,
const vector<bool>& keyEndInclusive);
void advanceTo(const BSONObj &keyBegin,
int keyBeginLen,
bool afterKey,
const vector<const BSONElement*>& keyEnd,
const vector<bool>& keyEndInclusive);
virtual BSONObj getKey() const;
virtual RecordId getRecordId() const;
virtual void advance();
virtual void savePosition();
virtual void restorePosition( OperationContext *txn );
private:
bool _locate(const BSONObj &key, const RecordId& loc);
OperationContext *_txn;
WiredTigerCursor _cursor;
const WiredTigerIndex& _idx; // not owned
bool _forward;
bool _eof;
mutable int _uniquePos;
mutable int _uniqueLen;
// For save/restorePosition check
RecoveryUnit* _savedForCheck;
BSONObj _savedKey;
RecordId _savedLoc;
};
const Ordering _ordering;
std::string _uri;
uint64_t _instanceId;
};
class WiredTigerIndexUnique : public WiredTigerIndex {
public:
WiredTigerIndexUnique( OperationContext* ctx,
const std::string& uri,
const IndexDescriptor* desc );
virtual bool unique() const { return true; }
virtual Status _insert( WT_CURSOR* c,
const BSONObj& key,
const RecordId& loc,
bool dupsAllowed );
virtual void _unindex( WT_CURSOR* c,
const BSONObj& key,
const RecordId& loc,
bool dupsAllowed );
};
class WiredTigerIndexStandard : public WiredTigerIndex {
public:
WiredTigerIndexStandard( OperationContext* ctx,
const std::string& uri,
const IndexDescriptor* desc );
virtual bool unique() const { return false; }
virtual Status _insert( WT_CURSOR* c,
const BSONObj& key,
const RecordId& loc,
bool dupsAllowed );
virtual void _unindex( WT_CURSOR* c,
const BSONObj& key,
const RecordId& loc,
bool dupsAllowed );
};
} // namespace
|
