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
|
/**
* Copyright (C) 2013 10gen 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/status.h"
#include "mongo/base/status_with.h"
#include "mongo/db/index/index_access_method.h"
#include "mongo/db/index/index_descriptor.h"
#include "mongo/db/index/s2_common.h"
#include "mongo/db/jsobj.h"
namespace mongo {
class S2AccessMethod : public IndexAccessMethod {
public:
S2AccessMethod(IndexCatalogEntry* btreeState, SortedDataInterface* btree);
/**
* Takes an index spec object for this index and returns a copy tweaked to conform to the
* expected format. When an index build is initiated, this function is called on the spec
* object the user provides, and the return value of this function is the final spec object
* that gets saved in the index catalog.
*
* Returns a non-OK status if 'specObj' is invalid.
*/
static StatusWith<BSONObj> fixSpec(const BSONObj& specObj);
private:
/**
* Fills 'keys' with the keys that should be generated for 'obj' on this index.
*
* This function ignores the 'multikeyPaths' pointer because text indexes don't support tracking
* path-level multikey information.
*
* If the 'multikeyPaths' pointer is non-null, then it must point to an empty vector. This
* function resizes 'multikeyPaths' to have the same number of elements as the index key pattern
* and fills each element with the prefixes of the indexed field that would cause this index to
* be multikey as a result of inserting 'keys'.
*/
void doGetKeys(const BSONObj& obj, BSONObjSet* keys, MultikeyPaths* multikeyPaths) const final;
S2IndexingParams _params;
// Null if this index orders strings according to the simple binary compare. If non-null,
// represents the collator used to generate index keys for indexed strings.
const CollatorInterface* _collator;
};
} // namespace mongo
|
