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
|
/**
* 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/db/dbmessage.h"
#include "mongo/db/jsobj.h"
#include "mongo/db/matcher/expression.h"
#include "mongo/db/matcher/extensions_callback_noop.h"
#include "mongo/db/query/collation/collator_interface.h"
#include "mongo/db/query/parsed_projection.h"
#include "mongo/db/query/query_request.h"
namespace mongo {
class OperationContext;
class CanonicalQuery {
public:
/**
* If parsing succeeds, returns a std::unique_ptr<CanonicalQuery> representing the parsed
* query (which will never be NULL). If parsing fails, returns an error Status.
*
* 'opCtx' must point to a valid OperationContext, but 'opCtx' does not need to outlive the
* returned CanonicalQuery.
*
* Used for legacy find through the OP_QUERY message.
*/
static StatusWith<std::unique_ptr<CanonicalQuery>> canonicalize(
OperationContext* opCtx,
const QueryMessage& qm,
const boost::intrusive_ptr<ExpressionContext>& expCtx = nullptr,
const ExtensionsCallback& extensionsCallback = ExtensionsCallbackNoop(),
MatchExpressionParser::AllowedFeatureSet allowedFeatures =
MatchExpressionParser::kDefaultSpecialFeatures);
/**
* If parsing succeeds, returns a std::unique_ptr<CanonicalQuery> representing the parsed
* query (which will never be NULL). If parsing fails, returns an error Status.
*
* 'opCtx' must point to a valid OperationContext, but 'opCtx' does not need to outlive the
* returned CanonicalQuery.
*/
static StatusWith<std::unique_ptr<CanonicalQuery>> canonicalize(
OperationContext* opCtx,
std::unique_ptr<QueryRequest> qr,
const boost::intrusive_ptr<ExpressionContext>& expCtx = nullptr,
const ExtensionsCallback& extensionsCallback = ExtensionsCallbackNoop(),
MatchExpressionParser::AllowedFeatureSet allowedFeatures =
MatchExpressionParser::kDefaultSpecialFeatures);
/**
* For testing or for internal clients to use.
*/
/**
* Used for creating sub-queries from an existing CanonicalQuery.
*
* 'root' must be an expression in baseQuery.root().
*
* Does not take ownership of 'root'.
*/
static StatusWith<std::unique_ptr<CanonicalQuery>> canonicalize(OperationContext* opCtx,
const CanonicalQuery& baseQuery,
MatchExpression* root);
/**
* Returns true if "query" describes an exact-match query on _id.
*/
static bool isSimpleIdQuery(const BSONObj& query);
const NamespaceString& nss() const {
return _qr->nss();
}
const std::string& ns() const {
return _qr->nss().ns();
}
//
// Accessors for the query
//
MatchExpression* root() const {
return _root.get();
}
BSONObj getQueryObj() const {
return _qr->getFilter();
}
const QueryRequest& getQueryRequest() const {
return *_qr;
}
const ParsedProjection* getProj() const {
return _proj.get();
}
const CollatorInterface* getCollator() const {
return _collator.get();
}
/**
* Sets this CanonicalQuery's collator, and sets the collator on this CanonicalQuery's match
* expression tree.
*
* This setter can be used to override the collator that was created from the query request
* during CanonicalQuery construction.
*/
void setCollator(std::unique_ptr<CollatorInterface> collator);
// Debugging
std::string toString() const;
std::string toStringShort() const;
/**
* Validates match expression, checking for certain
* combinations of operators in match expression and
* query options in QueryRequest.
* Since 'root' is derived from 'filter' in QueryRequest,
* 'filter' is not validated.
*
* TODO: Move this to query_validator.cpp
*/
static Status isValid(MatchExpression* root, const QueryRequest& parsed);
/**
* Traverses expression tree post-order.
* Sorts children at each non-leaf node by (MatchType, path(), children, number of children)
*/
static void sortTree(MatchExpression* tree);
/**
* Returns a count of 'type' nodes in expression tree.
*/
static size_t countNodes(const MatchExpression* root, MatchExpression::MatchType type);
/**
* Returns true if this canonical query may have converted extensions such as $where and $text
* into no-ops during parsing. This will be the case if it allowed $where and $text in parsing,
* but parsed using an ExtensionsCallbackNoop. This does not guarantee that a $where or $text
* existed in the query.
*
* Queries with a no-op extension context are special because they can be parsed and planned,
* but they cannot be executed.
*/
bool canHaveNoopMatchNodes() const {
return _canHaveNoopMatchNodes;
}
private:
// You must go through canonicalize to create a CanonicalQuery.
CanonicalQuery() {}
Status init(OperationContext* opCtx,
std::unique_ptr<QueryRequest> qr,
bool canHaveNoopMatchNodes,
std::unique_ptr<MatchExpression> root,
std::unique_ptr<CollatorInterface> collator);
std::unique_ptr<QueryRequest> _qr;
// _root points into _qr->getFilter()
std::unique_ptr<MatchExpression> _root;
std::unique_ptr<ParsedProjection> _proj;
std::unique_ptr<CollatorInterface> _collator;
bool _canHaveNoopMatchNodes = false;
};
} // namespace mongo
|
