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
|
/**
* 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 <boost/optional.hpp>
#include <string>
#include "mongo/db/catalog/collection_options.h"
#include "mongo/db/jsobj.h"
#include "mongo/db/operation_context.h"
#include "mongo/db/query/find_command_gen.h"
#include "mongo/db/query/tailable_mode.h"
namespace mongo {
class QueryMessage;
class Status;
template <typename T>
class StatusWith;
/**
* Parses the QueryMessage or find command received from the user and makes the various fields
* more easily accessible.
*/
namespace query_request_helper {
static constexpr auto kMaxTimeMSOpOnlyField = "maxTimeMSOpOnly";
// Field names for sorting options.
static constexpr auto kNaturalSortField = "$natural";
static constexpr auto kShardVersionField = "shardVersion";
/**
* Assert that collectionName is valid.
*/
Status validateGetMoreCollectionName(StringData collectionName);
/**
* Returns a non-OK status if any property of the QR has a bad value (e.g. a negative skip
* value) or if there is a bad combination of options (e.g. awaitData is illegal without
* tailable).
*/
Status validateFindCommand(const FindCommand& findCommand);
/**
* Parses a find command object, 'cmdObj'. Caller must indicate whether or not this lite
* parsed query is an explained query or not via 'isExplain'. Accepts a NSS with which
* to initialize the FindCommand if there is no UUID in cmdObj.
*
* Returns a heap allocated FindCommand on success or an error if 'cmdObj' is not well
* formed.
*/
std::unique_ptr<FindCommand> makeFromFindCommand(const BSONObj& cmdObj,
boost::optional<NamespaceString> nss,
bool apiStrict);
std::unique_ptr<FindCommand> makeFromFindCommandForTests(
const BSONObj& cmdObj,
boost::optional<NamespaceString> nss = boost::none,
bool apiStrict = false);
/**
* If _uuid exists for this FindCommand, update the value of _nss.
*/
void refreshNSS(const NamespaceString& nss, FindCommand* findCommand);
/**
* Converts this FindCommand into an aggregation using $match. If this FindCommand has options
* that cannot be satisfied by aggregation, a non-OK status is returned and 'cmdBuilder' is not
* modified.
*/
StatusWith<BSONObj> asAggregationCommand(const FindCommand& findCommand);
/**
* Helper function to identify text search sort key
* Example: {a: {$meta: "textScore"}}
*/
bool isTextScoreMeta(BSONElement elt);
// Read preference is attached to commands in "wrapped" form, e.g.
// { $query: { <cmd>: ... } , <kWrappedReadPrefField>: { ... } }
//
// However, mongos internally "unwraps" the read preference and adds it as a parameter to the
// command, e.g.
// { <cmd>: ... , <kUnwrappedReadPrefField>: { <kWrappedReadPrefField>: { ... } } }
static constexpr auto kWrappedReadPrefField = "$readPreference";
static constexpr auto kUnwrappedReadPrefField = "$queryOptions";
// Names of the maxTimeMS command and query option.
// Char arrays because they are used in static initialization.
static constexpr auto cmdOptionMaxTimeMS = "maxTimeMS";
static constexpr auto queryOptionMaxTimeMS = "$maxTimeMS";
// Names of the $meta projection values.
static constexpr auto metaGeoNearDistance = "geoNearDistance";
static constexpr auto metaGeoNearPoint = "geoNearPoint";
static constexpr auto metaRecordId = "recordId";
static constexpr auto metaSortKey = "sortKey";
static constexpr auto metaTextScore = "textScore";
// A constant by which 'maxTimeMSOpOnly' values are allowed to exceed the max allowed value for
// 'maxTimeMS'. This is because mongod and mongos server processes add a small amount to the
// 'maxTimeMS' value they are given before passing it on as 'maxTimeMSOpOnly', to allow for
// clock precision.
static constexpr auto kMaxTimeMSOpOnlyMaxPadding = 100LL;
static constexpr auto kDefaultBatchSize = 101ll;
void setTailableMode(TailableModeEnum tailableMode, FindCommand* findCommand);
TailableModeEnum getTailableMode(const FindCommand& findCommand);
/**
* Asserts whether the cursor response adhere to the format defined in IDL.
*/
void validateCursorResponse(const BSONObj& outputAsBson);
//
// Old parsing code: SOON TO BE DEPRECATED.
//
/**
* Parse the provided QueryMessage and return a heap constructed FindCommand, which
* represents it or an error.
*/
StatusWith<std::unique_ptr<FindCommand>> fromLegacyQueryMessage(const QueryMessage& qm,
bool* explain);
/**
* Parse the provided legacy query object and parameters to construct a FindCommand.
*/
StatusWith<std::unique_ptr<FindCommand>> fromLegacyQuery(NamespaceStringOrUUID nsOrUuid,
const BSONObj& queryObj,
const BSONObj& proj,
int ntoskip,
int ntoreturn,
int queryOptions,
bool* explain);
StatusWith<std::unique_ptr<FindCommand>> fromLegacyQueryFindCommand(NamespaceStringOrUUID nsOrUuid,
const BSONObj& queryObj,
const BSONObj& proj,
int ntoskip,
int ntoreturn,
int queryOptions);
} // namespace query_request_helper
} // namespace mongo
|
