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
|
/**
* 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 "mongo/db/commands.h"
#include "mongo/db/query/classic_plan_cache.h"
#include "mongo/db/query/query_settings.h"
#include "mongo/db/query/sbe_plan_cache.h"
namespace mongo {
/**
* DB commands for index filters.
* Index filter commands work on a different data structure in the collection
* info cache from the plan cache.
* The user still thinks of index filter commands as part of the plan cache functionality
* so the command name prefix is still "planCache".
*
* These are in a header to facilitate unit testing. See index_filter_commands_test.cpp.
*/
/**
* IndexFilterCommand
* Defines common attributes for all index filter related commands
* such as slaveOk.
*/
class IndexFilterCommand : public BasicCommand {
public:
IndexFilterCommand(const std::string& name, const std::string& helpText);
/**
* 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 DatabaseName&,
const BSONObj& cmdObj,
BSONObjBuilder& result) override;
bool supportsWriteConcern(const BSONObj& cmd) const override;
AllowedOnSecondary secondaryAllowed(ServiceContext*) const override;
std::string help() const override;
/**
* One action type defined for index filter commands:
* - planCacheIndexFilter
*/
Status checkAuthForOperation(OperationContext* opCtx,
const DatabaseName& dbName,
const BSONObj& cmdObj) const override;
virtual Status runIndexFilterCommand(OperationContext* opCtx,
const CollectionPtr& collection,
const BSONObj& cmdObj,
BSONObjBuilder* bob) = 0;
private:
std::string helpText;
};
/**
* ListFilters
*
* { planCacheListFilters: <collection> }
*
*/
class ListFilters : public IndexFilterCommand {
public:
ListFilters();
Status runIndexFilterCommand(OperationContext* opCtx,
const CollectionPtr& collection,
const BSONObj& cmdObj,
BSONObjBuilder* bob) override;
/**
* Looks up index filters from collection's query settings.
* Inserts index filters into BSON builder.
*/
static Status list(const QuerySettings& querySettings, BSONObjBuilder* bob);
};
/**
* ClearFilters
*
* { planCacheClearFilters: <collection>, query: <query>, sort: <sort>, projection: <projection> }
*
*/
class ClearFilters : public IndexFilterCommand {
public:
ClearFilters();
Status runIndexFilterCommand(OperationContext* opCtx,
const CollectionPtr& collection,
const BSONObj& cmdObj,
BSONObjBuilder* bob) override;
/**
* Removes corresponding entries from plan caches. If query shape is provided, clears index
* filter for the query. Otherwise, clears collection's filters.
*/
static Status clear(OperationContext* opCtx,
const CollectionPtr& collection,
const BSONObj& cmdObj,
QuerySettings* querySettings,
PlanCache* planCacheClassic,
sbe::PlanCache* planCacheSBE);
};
/**
* SetFilter
*
* {
* planCacheSetFilter: <collection>,
* query: <query>,
* sort: <sort>,
* projection: <projection>,
* indexes: [ <index1>, <index2>, <index3>, ... ]
* }
*
*/
class SetFilter : public IndexFilterCommand {
public:
SetFilter();
Status runIndexFilterCommand(OperationContext* opCtx,
const CollectionPtr& collection,
const BSONObj& cmdObj,
BSONObjBuilder* bob) override;
/**
* Sets index filter for a query shape. Removes entries for the query shape from plan cache.
*/
static Status set(OperationContext* opCtx,
const CollectionPtr& collection,
const BSONObj& cmdObj,
QuerySettings* querySettings,
PlanCache* planCacheClassic,
sbe::PlanCache* planCacheSBE);
};
} // namespace mongo
|
