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.
*/
#include "mongo/base/error_codes.h"
#include "mongo/base/init.h"
#include "mongo/db/auth/authorization_session.h"
#include "mongo/db/client.h"
#include "mongo/db/commands.h"
#include "mongo/db/query/collation/collation_spec.h"
#include "mongo/s/commands/strategy.h"
#include "mongo/s/grid.h"
#include "mongo/s/stale_exception.h"
namespace mongo {
namespace {
using std::string;
using std::stringstream;
using std::vector;
/**
* Base class for mongos plan cache commands.
* Cluster plan cache commands don't do much more than
* forwarding the commands to all shards and combining the results.
*/
class ClusterPlanCacheCmd : public BasicCommand {
ClusterPlanCacheCmd(const ClusterPlanCacheCmd&) = delete;
ClusterPlanCacheCmd& operator=(const ClusterPlanCacheCmd&) = delete;
public:
virtual ~ClusterPlanCacheCmd() {}
AllowedOnSecondary secondaryAllowed(ServiceContext*) const override {
return AllowedOnSecondary::kOptIn;
}
bool supportsWriteConcern(const BSONObj& cmd) const override {
return false;
}
std::string help() const override {
return _helpText;
}
std::string parseNs(const std::string& dbname, const BSONObj& cmdObj) const override {
return CommandHelpers::parseNsCollectionRequired(dbname, cmdObj).ns();
}
Status checkAuthForCommand(Client* client,
const std::string& dbname,
const BSONObj& cmdObj) const {
AuthorizationSession* authzSession = AuthorizationSession::get(client);
ResourcePattern pattern = parseResourcePattern(dbname, cmdObj);
if (authzSession->isAuthorizedForActionsOnResource(pattern, _actionType)) {
return Status::OK();
}
return Status(ErrorCodes::Unauthorized, "unauthorized");
}
// Cluster plan cache command entry point.
bool run(OperationContext* opCtx,
const std::string& dbname,
const BSONObj& cmdObj,
BSONObjBuilder& result);
public:
/**
* Instantiates a command that can be invoked by "name", which will be described by
* "helpText", and will require privilege "actionType" to run.
*/
ClusterPlanCacheCmd(const std::string& name, const std::string& helpText, ActionType actionType)
: BasicCommand(name), _helpText(helpText), _actionType(actionType) {}
private:
std::string _helpText;
ActionType _actionType;
};
//
// Cluster plan cache command implementation(s) below
//
bool ClusterPlanCacheCmd::run(OperationContext* opCtx,
const std::string& dbName,
const BSONObj& cmdObj,
BSONObjBuilder& result) {
const NamespaceString nss(CommandHelpers::parseNsCollectionRequired(dbName, cmdObj));
// Dispatch command to all the shards.
// Targeted shard commands are generally data-dependent but plan cache
// commands are tied to query shape (data has no effect on query shape).
vector<Strategy::CommandResult> results;
const BSONObj query;
Strategy::commandOp(opCtx,
dbName,
CommandHelpers::filterCommandRequestForPassthrough(cmdObj),
nss.ns(),
query,
CollationSpec::kSimpleSpec,
&results);
// Set value of first shard result's "ok" field.
bool clusterCmdResult = true;
for (vector<Strategy::CommandResult>::const_iterator i = results.begin(); i != results.end();
++i) {
const Strategy::CommandResult& cmdResult = *i;
// XXX: In absence of sensible aggregation strategy,
// promote first shard's result to top level.
if (i == results.begin()) {
CommandHelpers::filterCommandReplyForPassthrough(cmdResult.result, &result);
clusterCmdResult = cmdResult.result["ok"].trueValue();
}
// Append shard result as a sub object.
// Name the field after the shard.
string shardName = cmdResult.shardTargetId.toString();
result.append(shardName, cmdResult.result);
}
return clusterCmdResult;
}
//
// Register plan cache commands at startup
//
MONGO_INITIALIZER(RegisterPlanCacheCommands)(InitializerContext* context) {
// Leaked intentionally: a Command registers itself when constructed.
new ClusterPlanCacheCmd("planCacheListQueryShapes",
"Displays all query shapes in a collection.",
ActionType::planCacheRead);
new ClusterPlanCacheCmd("planCacheClear",
"Drops one or all cached queries in a collection.",
ActionType::planCacheWrite);
new ClusterPlanCacheCmd("planCacheListPlans",
"Displays the cached plans for a query shape.",
ActionType::planCacheRead);
return Status::OK();
}
} // namespace
} // namespace mongo
|
