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
|
/**
* 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 "mongo/db/query/explain_options.h"
#include "mongo/bson/bsonobjbuilder.h"
#include "mongo/db/command_generic_argument.h"
#include "mongo/util/assert_util.h"
namespace mongo {
constexpr StringData ExplainOptions::kCommandName;
constexpr StringData ExplainOptions::kVerbosityName;
constexpr StringData ExplainOptions::kQueryPlannerVerbosityStr;
constexpr StringData ExplainOptions::kExecStatsVerbosityStr;
constexpr StringData ExplainOptions::kAllPlansExecutionVerbosityStr;
StringData ExplainOptions::verbosityString(ExplainOptions::Verbosity verbosity) {
switch (verbosity) {
case Verbosity::kQueryPlanner:
return kQueryPlannerVerbosityStr;
case Verbosity::kExecStats:
return kExecStatsVerbosityStr;
case Verbosity::kExecAllPlans:
return kAllPlansExecutionVerbosityStr;
default:
MONGO_UNREACHABLE;
}
}
StatusWith<ExplainOptions::Verbosity> ExplainOptions::parseCmdBSON(const BSONObj& cmdObj) {
auto verbosity = Verbosity::kExecAllPlans;
for (auto&& field : cmdObj) {
auto fieldName = field.fieldNameStringData();
if (fieldName == kCommandName) {
if (BSONType::Object != field.type()) {
return Status(ErrorCodes::FailedToParse,
"explain command requires a nested object");
}
} else if (fieldName == kVerbosityName) {
if (field.type() != BSONType::String) {
return Status(ErrorCodes::FailedToParse, "explain verbosity must be a string");
}
auto verbStr = field.valueStringData();
if (verbStr == kQueryPlannerVerbosityStr) {
verbosity = Verbosity::kQueryPlanner;
} else if (verbStr == kExecStatsVerbosityStr) {
verbosity = Verbosity::kExecStats;
} else if (verbStr != kAllPlansExecutionVerbosityStr) {
return Status(ErrorCodes::FailedToParse,
str::stream()
<< "verbosity string must be one of {'"
<< kQueryPlannerVerbosityStr << "', '" << kExecStatsVerbosityStr
<< "', '" << kAllPlansExecutionVerbosityStr << "'}");
}
} else if (fieldName == "collation" || fieldName == "use44SortKeys" ||
fieldName == "useNewUpsert") {
// TODO SERVER-48560: we ingest these fields for compatibility with 4.4,
// whose mongoS incorrectly adds them to the explain command for an
// aggregation instead of adding them into the wrapped aggregate command
// itself. Remove this block when 5.0 becomes last-lts.
continue;
} else if (!isGenericArgument(fieldName)) {
return Status(ErrorCodes::InvalidOptions,
str::stream() << "unexpected field '" << fieldName
<< "' in explain command object");
}
}
return verbosity;
}
BSONObj ExplainOptions::toBSON(ExplainOptions::Verbosity verbosity) {
BSONObjBuilder explainOptionsBuilder;
explainOptionsBuilder.append(kVerbosityName, StringData(verbosityString(verbosity)));
return explainOptionsBuilder.obj();
}
} // namespace mongo
|
