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
|
/**
* Copyright (C) 2014 MongoDB 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.
*/
#include "mongo/platform/basic.h"
#include "mongo/db/command_can_run_here.h"
#include "mongo/db/commands.h"
#include "mongo/db/query/explain.h"
#include "mongo/util/mongoutils/str.h"
namespace mongo {
using std::string;
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 : public BasicCommand {
public:
CmdExplain() : BasicCommand("explain") {}
virtual bool supportsWriteConcern(const BSONObj& cmd) const override {
return false;
}
/**
* Running an explain on a secondary requires explicitly setting slaveOk.
*/
AllowedOnSecondary secondaryAllowed(ServiceContext*) const override {
return AllowedOnSecondary::kOptIn;
}
virtual bool maintenanceOk() const {
return false;
}
virtual bool adminOnly() const {
return false;
}
std::string help() const override {
return "explain database reads and writes";
}
std::string parseNs(const std::string& dbname, const BSONObj& cmdObj) const override {
uassert(ErrorCodes::BadValue,
"explain command requires a nested object",
Object == cmdObj.firstElement().type());
auto explainObj = cmdObj.firstElement().Obj();
Command* commToExplain = CommandHelpers::findCommand(explainObj.firstElementFieldName());
uassert(ErrorCodes::CommandNotFound,
str::stream() << "explain failed due to unknown command: "
<< explainObj.firstElementFieldName(),
commToExplain);
return commToExplain->parseNs(dbname, explainObj);
}
/**
* 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.
*/
virtual Status checkAuthForOperation(OperationContext* opCtx,
const std::string& dbname,
const BSONObj& cmdObj) const {
if (Object != cmdObj.firstElement().type()) {
return Status(ErrorCodes::BadValue, "explain command requires a nested object");
}
BSONObj explainObj = cmdObj.firstElement().Obj();
Command* commToExplain = CommandHelpers::findCommand(explainObj.firstElementFieldName());
if (NULL == commToExplain) {
mongoutils::str::stream ss;
ss << "unknown command: " << explainObj.firstElementFieldName();
return Status(ErrorCodes::CommandNotFound, ss);
}
return commToExplain->checkAuthForRequest(
opCtx, OpMsgRequest::fromDBAndBody(dbname, std::move(explainObj)));
}
virtual bool run(OperationContext* opCtx,
const std::string& dbname,
const BSONObj& cmdObj,
BSONObjBuilder& result) {
auto verbosity = ExplainOptions::parseCmdBSON(cmdObj);
if (!verbosity.isOK()) {
return CommandHelpers::appendCommandStatus(result, verbosity.getStatus());
}
// This is the nested command which we are explaining.
BSONObj explainObj = cmdObj.firstElement().Obj();
if (auto innerDb = explainObj["$db"]) {
uassert(ErrorCodes::InvalidNamespace,
str::stream() << "Mismatched $db in explain command. Expected " << dbname
<< " but got "
<< innerDb.checkAndGetStringData(),
innerDb.checkAndGetStringData() == dbname);
}
Command* commToExplain = CommandHelpers::findCommand(explainObj.firstElementFieldName());
if (NULL == commToExplain) {
mongoutils::str::stream ss;
ss << "Explain failed due to unknown command: " << explainObj.firstElementFieldName();
Status explainStatus(ErrorCodes::CommandNotFound, ss);
return CommandHelpers::appendCommandStatus(result, explainStatus);
}
if (!commandCanRunHere(opCtx, dbname, commToExplain)) {
mongoutils::str::stream ss;
ss << "Explain's child command cannot run on this node. "
<< "Are you explaining a write command on a secondary?";
CommandHelpers::appendCommandStatus(result, false, ss);
return false;
}
// Actually call the nested command's explain(...) method.
Status explainStatus =
commToExplain->explain(opCtx, dbname, explainObj, verbosity.getValue(), &result);
if (!explainStatus.isOK()) {
return CommandHelpers::appendCommandStatus(result, explainStatus);
}
return true;
}
} cmdExplain;
} // namespace
} // namespace mongo
|
