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
|
/**
* Copyright (C) 2018-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/db/exec/wildcard_projection.h"
#include "mongo/db/field_ref.h"
#include "mongo/db/index/btree_key_generator.h"
#include "mongo/db/query/collation/collator_interface.h"
#include "mongo/db/storage/key_string.h"
#include "mongo/db/storage/sorted_data_interface.h"
namespace mongo {
/**
* This class is responsible for generating an aggregation projection based on the keyPattern and
* pathProjection specs, and for subsequently extracting the set of all path-value pairs for each
* document.
*/
class WildcardKeyGenerator {
public:
static constexpr StringData kSubtreeSuffix = ".$**"_sd;
/**
* Returns an owned ProjectionExecutor identical to the one that WildcardKeyGenerator will use
* internally when generating the keys for the $** index, as defined by the 'keyPattern' and
* 'pathProjection' arguments.
*/
static WildcardProjection createProjectionExecutor(BSONObj keyPattern, BSONObj pathProjection);
WildcardKeyGenerator(BSONObj keyPattern,
BSONObj pathProjection,
const CollatorInterface* collator,
KeyString::Version keyStringVersion,
Ordering ordering);
/**
* Returns a pointer to the key generator's underlying ProjectionExecutor.
*/
const WildcardProjection* getWildcardProjection() const {
return &_proj;
}
BSONObj getKeyPattern() const {
return _keyPattern;
}
/**
* Applies the appropriate Wildcard projection to the input doc, and then adds one key-value
* pair to the set 'keys' for each leaf node in the post-projection document:
* { '': 'path.to.field', '': <collation-aware-field-value> }
* Also adds one entry to 'multikeyPaths' for each array encountered in the post-projection
* document, in the following format:
* { '': 1, '': 'path.to.array' }
*/
void generateKeys(SharedBufferFragmentBuilder& pooledBufferBuilder,
BSONObj inputDoc,
KeyStringSet* keys,
KeyStringSet* multikeyPaths,
boost::optional<RecordId> id = boost::none) const;
private:
// Traverses every path of the post-projection document, adding keys to the set as it goes.
void _traverseWildcard(SharedBufferFragmentBuilder& pooledBufferBuilder,
BSONObj obj,
bool objIsArray,
FieldRef* path,
KeyStringSet* nonWildcardKeys,
KeyStringSet::sequence_type* keys,
KeyStringSet::sequence_type* multikeyPaths,
boost::optional<RecordId> id) const;
// Helper functions to format the entry appropriately before adding it to the key/path tracker.
void _addMultiKey(SharedBufferFragmentBuilder& pooledBufferBuilder,
const FieldRef& fullPath,
KeyStringSet::sequence_type* multikeyPaths) const;
void _addWildcard(KeyString::PooledBuilder& keyString,
BSONElement elem,
const FieldRef& fullPath,
KeyStringSet::sequence_type* keys,
boost::optional<RecordId> id) const;
void _addKey(SharedBufferFragmentBuilder& pooledBufferBuilder,
BSONElement elem,
const FieldRef& fullPath,
KeyStringSet* nonWildcardKeys,
KeyStringSet::sequence_type* keys,
boost::optional<RecordId> id) const;
// Helper to check whether the element is a nested array, and conditionally add it to 'keys'.
bool _addKeyForNestedArray(SharedBufferFragmentBuilder& pooledBufferBuilder,
BSONElement elem,
const FieldRef& fullPath,
bool enclosingObjIsArray,
KeyStringSet* nonWildcardKeys,
KeyStringSet::sequence_type* keys,
boost::optional<RecordId> id) const;
bool _addKeyForEmptyLeaf(SharedBufferFragmentBuilder& pooledBufferBuilder,
BSONElement elem,
const FieldRef& fullPath,
KeyStringSet* nonWildcardKeys,
KeyStringSet::sequence_type* keys,
boost::optional<RecordId> id) const;
WildcardProjection _proj;
const CollatorInterface* _collator;
const BSONObj _keyPattern;
const KeyString::Version _keyStringVersion;
const Ordering _ordering;
std::unique_ptr<BtreeKeyGenerator> _indexKeyGen;
};
} // namespace mongo
|
