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
|
/**
* 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.
*/
#include "mongo/platform/basic.h"
#include "mongo/db/pipeline/expression_dependencies.h"
#include "mongo/db/query/sort_pattern.h"
#include "mongo/db/storage/storage_parameters_gen.h"
namespace mongo {
SortPattern::SortPattern(const BSONObj& obj,
const boost::intrusive_ptr<ExpressionContext>& pExpCtx) {
for (auto&& keyField : obj) {
auto fieldName = keyField.fieldNameStringData();
SortPatternPart patternPart;
if (keyField.type() == Object) {
BSONObj metaDoc = keyField.Obj();
// this restriction is due to needing to figure out sort direction
uassert(17312,
"$meta is the only expression supported by $sort right now",
metaDoc.firstElement().fieldNameStringData() == "$meta");
uassert(ErrorCodes::FailedToParse,
"Cannot have additional keys in a $meta sort specification",
metaDoc.nFields() == 1);
VariablesParseState vps = pExpCtx->variablesParseState;
BSONElement metaElem = metaDoc.firstElement();
if (metaElem.valueStringDataSafe() == "textScore"_sd) {
// Valid meta sort. Just fall through.
} else if (metaElem.valueStringDataSafe() == "randVal"_sd) {
// Valid meta sort. Just fall through.
} else if (metaElem.valueStringDataSafe() == "geoNearDistance"_sd) {
if (!feature_flags::gTimeseriesMetricIndexes.isEnabled(
serverGlobalParams.featureCompatibility)) {
uasserted(5917100,
"$meta sort by 'geoNearDistance' is allowed only with "
"featureFlagTimeseriesMetricIndexes flag");
}
// Valid meta sort if the flag is enabled. Just fall through.
} else if (metaElem.valueStringDataSafe() == "searchScore"_sd) {
uasserted(31218, "$meta sort by 'searchScore' metadata is not supported");
} else if (metaElem.valueStringDataSafe() == "searchHighlights"_sd) {
uasserted(31219, "$meta sort by 'searchHighlights' metadata is not supported");
} else {
uasserted(31138, str::stream() << "Illegal $meta sort: " << metaElem);
}
patternPart.expression = static_cast<ExpressionMeta*>(
ExpressionMeta::parse(pExpCtx.get(), metaElem, vps).get());
// If sorting by textScore, sort highest scores first. If sorting by randVal, order
// doesn't matter, so just always use descending.
patternPart.isAscending = false;
_sortPattern.push_back(std::move(patternPart));
continue;
}
uassert(15974,
str::stream() << "Illegal key in $sort specification: " << keyField,
keyField.isNumber());
const auto direction = keyField.safeNumberLong();
uassert(15975,
"$sort key ordering must be 1 (for ascending) or -1 (for descending)",
((direction == 1) || (direction == -1)));
patternPart.fieldPath = FieldPath{fieldName};
patternPart.isAscending = (direction > 0);
const auto [_, inserted] = _paths.insert(patternPart.fieldPath->fullPath());
uassert(7472500,
str::stream() << "$sort key must not contain duplicate keys (duplicate: '"
<< patternPart.fieldPath->fullPath() << "')",
inserted);
_sortPattern.push_back(std::move(patternPart));
}
}
QueryMetadataBitSet SortPattern::metadataDeps(QueryMetadataBitSet unavailableMetadata) const {
DepsTracker depsTracker{unavailableMetadata};
for (auto&& part : _sortPattern) {
if (part.expression) {
expression::addDependencies(part.expression.get(), &depsTracker);
}
}
return depsTracker.metadataDeps();
}
Document SortPattern::serialize(SortKeySerialization serializationMode,
SerializationOptions options) const {
MutableDocument keyObj;
const size_t n = _sortPattern.size();
for (size_t i = 0; i < n; ++i) {
if (_sortPattern[i].fieldPath) {
keyObj.setField(options.serializeFieldPath(*_sortPattern[i].fieldPath),
Value(_sortPattern[i].isAscending ? 1 : -1));
} else {
// Sorting by an expression, use a made up field name.
auto computedFieldName = std::string(str::stream() << "$computed" << i);
switch (serializationMode) {
case SortKeySerialization::kForExplain:
case SortKeySerialization::kForPipelineSerialization: {
const bool isExplain = (serializationMode == SortKeySerialization::kForExplain);
keyObj[computedFieldName] = _sortPattern[i].expression->serialize(isExplain);
break;
}
case SortKeySerialization::kForSortKeyMerging: {
// We need to be able to tell which direction the sort is. Expression sorts are
// always descending.
keyObj[computedFieldName] = Value(-1);
break;
}
}
}
}
return keyObj.freeze();
}
void SortPattern::addDependencies(DepsTracker* deps) const {
for (auto&& keyPart : _sortPattern) {
if (keyPart.expression) {
expression::addDependencies(keyPart.expression.get(), deps);
} else {
deps->fields.insert(keyPart.fieldPath->fullPath());
}
}
}
bool SortPattern::isExtensionOf(const SortPattern& other) const {
// If the other is longer, this cannot be an extension of it.
if (_sortPattern.size() < other._sortPattern.size()) {
return false;
}
// For each sortPatternPart in the other sort pattern, make sure we have it as well in order.
for (unsigned int i = 0; i < other._sortPattern.size(); ++i) {
if (_sortPattern[i] != other._sortPattern[i]) {
return false;
}
}
return true;
}
} // namespace mongo
|
