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
|
/**
* Copyright (C) 2013 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.
*/
#pragma once
#include "mongo/db/commands.h"
#include "mongo/db/query/plan_cache.h"
namespace mongo {
/**
* DB commands for plan cache.
* These are in a header to facilitate unit testing. See plan_cache_commands_test.cpp.
*/
/**
* PlanCacheCommand
* Defines common attributes for all plan cache related commands
* such as slaveOk.
*/
class PlanCacheCommand : public BasicCommand {
public:
PlanCacheCommand(const std::string& name, const std::string& helpText, ActionType actionType);
/**
* Entry point from command subsystem.
* Implementation provides standardization of error handling
* such as adding error code and message to BSON result.
*
* Do not override in derived classes.
* Override runPlanCacheCommands instead to
* implement plan cache command functionality.
*/
bool run(OperationContext* opCtx,
const std::string& dbname,
const BSONObj& cmdObj,
BSONObjBuilder& result);
virtual bool supportsWriteConcern(const BSONObj& cmd) const override;
AllowedOnSecondary secondaryAllowed(ServiceContext*) const override;
std::string help() const override;
/**
* Two action types defined for plan cache commands:
* - planCacheRead
* - planCacheWrite
*/
virtual Status checkAuthForCommand(Client* client,
const std::string& dbname,
const BSONObj& cmdObj) const;
/**
* Subset of command arguments used by plan cache commands
* Override to provide command functionality.
* Should contain just enough logic to invoke run*Command() function
* in plan_cache.h
*/
virtual Status runPlanCacheCommand(OperationContext* opCtx,
const std::string& ns,
const BSONObj& cmdObj,
BSONObjBuilder* bob) = 0;
/**
* Validatess query shape from command object and returns canonical query.
*/
static StatusWith<std::unique_ptr<CanonicalQuery>> canonicalize(OperationContext* opCtx,
const std::string& ns,
const BSONObj& cmdObj);
private:
std::string helpText;
ActionType actionType;
};
/**
* planCacheListQueryShapes
*
* { planCacheListQueryShapes: <collection> }
*
*/
class PlanCacheListQueryShapes : public PlanCacheCommand {
public:
PlanCacheListQueryShapes();
virtual Status runPlanCacheCommand(OperationContext* opCtx,
const std::string& ns,
const BSONObj& cmdObj,
BSONObjBuilder* bob);
/**
* Looks up cache keys for collection's plan cache.
* Inserts keys for query into BSON builder.
*/
static Status list(const PlanCache& planCache, BSONObjBuilder* bob);
};
/**
* planCacheClear
*
* {
* planCacheClear: <collection>,
* query: <query>,
* sort: <sort>,
* projection: <projection>
* }
*
*/
class PlanCacheClear : public PlanCacheCommand {
public:
PlanCacheClear();
virtual Status runPlanCacheCommand(OperationContext* opCtx,
const std::string& ns,
const BSONObj& cmdObj,
BSONObjBuilder* bob);
/**
* Clears collection's plan cache.
* If query shape is provided, clears plans for that single query shape only.
*/
static Status clear(OperationContext* opCtx,
PlanCache* planCache,
const std::string& ns,
const BSONObj& cmdObj);
};
/**
* planCacheListPlans
*
* {
* planCacheListPlans: <collection>,
* query: <query>,
* sort: <sort>,
* projection: <projection>
* }
*
*/
class PlanCacheListPlans : public PlanCacheCommand {
public:
PlanCacheListPlans();
virtual Status runPlanCacheCommand(OperationContext* opCtx,
const std::string& ns,
const BSONObj& cmdObj,
BSONObjBuilder* bob);
/**
* Displays the cached plans for a query shape.
*/
static Status list(OperationContext* opCtx,
const PlanCache& planCache,
const std::string& ns,
const BSONObj& cmdObj,
BSONObjBuilder* bob);
};
} // namespace mongo
|
