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
196
197
198
199
200
201
202
203
|
/**
* 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.
*/
#include "mongo/platform/basic.h"
#include "mongo/db/command_can_run_here.h"
#include "mongo/db/commands.h"
#include "mongo/db/explain_gen.h"
#include "mongo/db/query/explain.h"
#include "mongo/util/database_name_util.h"
#include "mongo/util/str.h"
namespace mongo {
namespace {
/**
* The explain command is used to generate explain output for any read or write operation which has
* a query component (e.g. find, count, update, remove, distinct, etc.).
*
* The explain command takes as its argument a nested object which specifies the command to
* explain, and a verbosity indicator. For example:
*
* {explain: {count: "coll", query: {foo: "bar"}}, verbosity: "executionStats"}
*
* This command like a dispatcher: it just retrieves a pointer to the nested command and invokes
* its explain() implementation.
*/
class CmdExplain final : public Command {
public:
CmdExplain() : Command("explain") {}
const std::set<std::string>& apiVersions() const {
return kApiVersions1;
}
std::unique_ptr<CommandInvocation> parse(OperationContext* opCtx,
const OpMsgRequest& request) override;
/**
* Running an explain on a secondary requires explicitly setting slaveOk.
*/
AllowedOnSecondary secondaryAllowed(ServiceContext*) const override {
return AllowedOnSecondary::kOptIn;
}
bool allowedWithSecurityToken() const final {
return true;
}
bool maintenanceOk() const override {
return false;
}
bool adminOnly() const override {
return false;
}
bool collectsResourceConsumptionMetrics() const override {
return true;
}
std::string help() const override {
return "explain database reads and writes";
}
private:
class Invocation;
};
class CmdExplain::Invocation final : public CommandInvocation {
public:
Invocation(const CmdExplain* explainCommand,
const OpMsgRequest& request,
ExplainOptions::Verbosity verbosity,
std::unique_ptr<OpMsgRequest> innerRequest,
std::unique_ptr<CommandInvocation> innerInvocation)
: CommandInvocation(explainCommand),
_outerRequest{&request},
_dbName(DatabaseNameUtil::deserialize(_outerRequest->getValidatedTenantId(),
_outerRequest->getDatabase())),
_verbosity{std::move(verbosity)},
_innerRequest{std::move(innerRequest)},
_innerInvocation{std::move(innerInvocation)} {}
void run(OperationContext* opCtx, rpc::ReplyBuilderInterface* result) override {
// Explain is never allowed in multi-document transactions.
const bool inMultiDocumentTransaction = false;
uassert(50746,
"Explain's child command cannot run on this node. "
"Are you explaining a write command on a secondary?",
commandCanRunHere(
opCtx, _dbName, _innerInvocation->definition(), inMultiDocumentTransaction));
_innerInvocation->explain(opCtx, _verbosity, result);
}
void explain(OperationContext* opCtx,
ExplainOptions::Verbosity verbosity,
rpc::ReplyBuilderInterface* result) override {
uasserted(ErrorCodes::IllegalOperation, "Explain cannot explain itself.");
}
NamespaceString ns() const override {
return _innerInvocation->ns();
}
bool supportsWriteConcern() const override {
return false;
}
/**
* You are authorized to run an explain if you are authorized to run
* the command that you are explaining. The auth check is performed recursively
* on the nested command.
*/
void doCheckAuthorization(OperationContext* opCtx) const override {
_innerInvocation->checkAuthorization(opCtx, *_innerRequest);
}
private:
const CmdExplain* command() const {
return static_cast<const CmdExplain*>(definition());
}
const OpMsgRequest* _outerRequest;
const DatabaseName _dbName;
const NamespaceString _ns;
ExplainOptions::Verbosity _verbosity;
std::unique_ptr<OpMsgRequest> _innerRequest; // Lifespan must enclose that of _innerInvocation.
std::unique_ptr<CommandInvocation> _innerInvocation;
};
std::unique_ptr<CommandInvocation> CmdExplain::parse(OperationContext* opCtx,
const OpMsgRequest& request) {
CommandHelpers::uassertNoDocumentSequences(getName(), request);
// To enforce API versioning
auto cmdObj = ExplainCommandRequest::parse(
IDLParserContext(ExplainCommandRequest::kCommandName,
APIParameters::get(opCtx).getAPIStrict().value_or(false)),
request);
auto const dbName = cmdObj.getDbName();
ExplainOptions::Verbosity verbosity = cmdObj.getVerbosity();
auto explainedObj = cmdObj.getCommandParameter();
// Extract 'comment' field from the 'explainedObj' only if there is no top-level comment.
auto commentField = explainedObj["comment"];
if (!opCtx->getComment() && commentField) {
stdx::lock_guard<Client> lk(*opCtx->getClient());
opCtx->setComment(commentField.wrap());
}
if (auto innerDb = explainedObj["$db"]) {
auto innerDbName =
DatabaseNameUtil::deserialize(dbName.tenantId(), innerDb.checkAndGetStringData());
uassert(ErrorCodes::InvalidNamespace,
str::stream() << "Mismatched $db in explain command. Expected "
<< dbName.toStringForErrorMsg() << " but got "
<< innerDbName.toStringForErrorMsg(),
innerDbName == dbName);
}
auto explainedCommand = CommandHelpers::findCommand(explainedObj.firstElementFieldName());
uassert(ErrorCodes::CommandNotFound,
str::stream() << "Explain failed due to unknown command: "
<< explainedObj.firstElementFieldName(),
explainedCommand);
auto innerRequest =
std::make_unique<OpMsgRequest>(OpMsgRequestBuilder::createWithValidatedTenancyScope(
dbName, request.validatedTenancyScope, explainedObj));
auto innerInvocation = explainedCommand->parseForExplain(opCtx, *innerRequest, verbosity);
return std::make_unique<Invocation>(
this, request, std::move(verbosity), std::move(innerRequest), std::move(innerInvocation));
}
CmdExplain cmdExplain;
} // namespace
} // namespace mongo
|
