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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
|
/**
* 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 <memory>
#include "mongo/bson/bsonobjbuilder.h"
#include "mongo/db/auth/authorization_session.h"
#include "mongo/db/catalog/collection_catalog_entry.h"
#include "mongo/db/clientcursor.h"
#include "mongo/db/commands.h"
#include "mongo/db/concurrency/write_conflict_exception.h"
#include "mongo/db/curop.h"
#include "mongo/db/curop_failpoint_helpers.h"
#include "mongo/db/cursor_manager.h"
#include "mongo/db/db_raii.h"
#include "mongo/db/exec/queued_data_stage.h"
#include "mongo/db/exec/working_set.h"
#include "mongo/db/index/index_descriptor.h"
#include "mongo/db/query/cursor_request.h"
#include "mongo/db/query/cursor_response.h"
#include "mongo/db/query/find_common.h"
#include "mongo/db/service_context.h"
#include "mongo/db/storage/storage_engine.h"
#include "mongo/util/uuid.h"
namespace mongo {
using std::string;
using std::stringstream;
using std::unique_ptr;
using std::vector;
namespace {
// Failpoint which causes to hang "listIndexes" cmd after acquiring the DB lock.
MONGO_FAIL_POINT_DEFINE(hangBeforeListIndexes);
/**
* Lists the indexes for a given collection.
* If 'includeBuildUUIDs' is true, then the index build uuid is also returned alongside the index
* spec for in-progress index builds only.
*
* Format:
* {
* listIndexes: <collection name>,
* includeBuildUUIDs: <boolean>,
* }
*
* Return format:
* {
* indexes: [
* <index>,
* ...
* ]
* }
*
* Where '<index>' is the index spec if either the index is ready or 'includeBuildUUIDs' is false.
* If the index is in-progress and 'includeBuildUUIDs' is true then '<index>' has the following
* format:
* {
* spec: <index spec>,
* buildUUID: <index build uuid>
* }
*/
class CmdListIndexes : public BasicCommand {
public:
CmdListIndexes() : BasicCommand("listIndexes") {}
AllowedOnSecondary secondaryAllowed(ServiceContext*) const override {
return AllowedOnSecondary::kOptIn;
}
virtual bool adminOnly() const {
return false;
}
virtual bool supportsWriteConcern(const BSONObj& cmd) const override {
return false;
}
std::string help() const override {
return "list indexes for a collection";
}
Status checkAuthForOperation(OperationContext* opCtx,
const std::string& dbname,
const BSONObj& cmdObj) const override {
AuthorizationSession* authzSession = AuthorizationSession::get(opCtx->getClient());
if (!authzSession->isAuthorizedToParseNamespaceElement(cmdObj.firstElement())) {
return Status(ErrorCodes::Unauthorized, "Unauthorized");
}
// Check for the listIndexes ActionType on the database.
const auto nss = AutoGetCollection::resolveNamespaceStringOrUUID(
opCtx, CommandHelpers::parseNsOrUUID(dbname, cmdObj));
if (authzSession->isAuthorizedForActionsOnResource(ResourcePattern::forExactNamespace(nss),
ActionType::listIndexes)) {
return Status::OK();
}
return Status(ErrorCodes::Unauthorized,
str::stream() << "Not authorized to list indexes on collection: "
<< nss.ns());
}
bool run(OperationContext* opCtx,
const string& dbname,
const BSONObj& cmdObj,
BSONObjBuilder& result) {
CommandHelpers::handleMarkKillOnClientDisconnect(opCtx);
const long long defaultBatchSize = std::numeric_limits<long long>::max();
long long batchSize;
uassertStatusOK(
CursorRequest::parseCommandCursorOptions(cmdObj, defaultBatchSize, &batchSize));
auto includeBuildUUIDs = cmdObj["includeBuildUUIDs"].trueValue();
NamespaceString nss;
std::unique_ptr<PlanExecutor, PlanExecutor::Deleter> exec;
BSONArrayBuilder firstBatch;
{
AutoGetCollectionForReadCommand ctx(opCtx,
CommandHelpers::parseNsOrUUID(dbname, cmdObj));
Collection* collection = ctx.getCollection();
uassert(ErrorCodes::NamespaceNotFound,
str::stream() << "ns does not exist: " << ctx.getNss().ns(),
collection);
const CollectionCatalogEntry* cce = collection->getCatalogEntry();
invariant(cce);
nss = ctx.getNss();
CurOpFailpointHelpers::waitWhileFailPointEnabled(
&hangBeforeListIndexes, opCtx, "hangBeforeListIndexes", []() {}, false, nss);
vector<string> indexNames;
writeConflictRetry(opCtx, "listIndexes", nss.ns(), [&] {
indexNames.clear();
cce->getAllIndexes(opCtx, &indexNames);
});
auto ws = std::make_unique<WorkingSet>();
auto root = std::make_unique<QueuedDataStage>(opCtx, ws.get());
for (size_t i = 0; i < indexNames.size(); i++) {
auto indexSpec = writeConflictRetry(opCtx, "listIndexes", nss.ns(), [&] {
if (includeBuildUUIDs && !cce->isIndexReady(opCtx, indexNames[i])) {
BSONObjBuilder builder;
builder.append("spec"_sd, cce->getIndexSpec(opCtx, indexNames[i]));
// TODO(SERVER-37980): Replace with index build UUID.
auto indexBuildUUID = UUID::gen();
indexBuildUUID.appendToBuilder(&builder, "buildUUID"_sd);
return builder.obj();
}
return cce->getIndexSpec(opCtx, indexNames[i]);
});
WorkingSetID id = ws->allocate();
WorkingSetMember* member = ws->get(id);
member->keyData.clear();
member->recordId = RecordId();
member->obj = Snapshotted<BSONObj>(SnapshotId(), indexSpec.getOwned());
member->transitionToOwnedObj();
root->pushBack(id);
}
exec = uassertStatusOK(PlanExecutor::make(
opCtx, std::move(ws), std::move(root), nss, PlanExecutor::NO_YIELD));
for (long long objCount = 0; objCount < batchSize; objCount++) {
BSONObj next;
PlanExecutor::ExecState state = exec->getNext(&next, NULL);
if (state == PlanExecutor::IS_EOF) {
break;
}
invariant(state == PlanExecutor::ADVANCED);
// If we can't fit this result inside the current batch, then we stash it for later.
if (!FindCommon::haveSpaceForNext(next, objCount, firstBatch.len())) {
exec->enqueue(next);
break;
}
firstBatch.append(next);
}
if (exec->isEOF()) {
appendCursorResponseObject(0LL, nss.ns(), firstBatch.arr(), &result);
return true;
}
exec->saveState();
exec->detachFromOperationContext();
} // Drop collection lock. Global cursor registration must be done without holding any
// locks.
const auto pinnedCursor = CursorManager::get(opCtx)->registerCursor(
opCtx,
{std::move(exec),
nss,
AuthorizationSession::get(opCtx->getClient())->getAuthenticatedUserNames(),
opCtx->getWriteConcern(),
repl::ReadConcernArgs::get(opCtx),
cmdObj,
ClientCursorParams::LockPolicy::kLocksInternally,
{Privilege(ResourcePattern::forExactNamespace(nss), ActionType::listIndexes)}});
appendCursorResponseObject(
pinnedCursor.getCursor()->cursorid(), nss.ns(), firstBatch.arr(), &result);
return true;
}
} cmdListIndexes;
} // namespace
} // namespace mongo
|
