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
|
/**
* Copyright (C) 2020-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/pipeline/plan_explainer_pipeline.h"
#include "mongo/db/pipeline/document_source_cursor.h"
#include "mongo/db/pipeline/document_source_facet.h"
#include "mongo/db/pipeline/document_source_lookup.h"
#include "mongo/db/pipeline/document_source_sort.h"
#include "mongo/db/pipeline/document_source_union_with.h"
#include "mongo/db/pipeline/plan_executor_pipeline.h"
#include "mongo/db/query/explain.h"
#include "mongo/db/query/plan_summary_stats_visitor.h"
namespace mongo {
/**
* Templatized method to get plan summary stats from document source and aggregate it to 'statsOut'.
*/
template <typename DocSourceType, typename DocSourceStatType>
void collectPlanSummaryStats(const DocSourceType& source, PlanSummaryStats* statsOut) {
auto specificStats = source.getSpecificStats();
invariant(specificStats);
auto visitor = PlanSummaryStatsVisitor(*statsOut);
specificStats->acceptVisitor(&visitor);
}
const PlanExplainer::ExplainVersion& PlanExplainerPipeline::getVersion() const {
static const ExplainVersion kExplainVersion = "1";
if (auto docSourceCursor =
dynamic_cast<DocumentSourceCursor*>(_pipeline->getSources().front().get())) {
return docSourceCursor->getExplainVersion();
}
return kExplainVersion;
}
std::string PlanExplainerPipeline::getPlanSummary() const {
if (auto docSourceCursor =
dynamic_cast<DocumentSourceCursor*>(_pipeline->getSources().front().get())) {
return docSourceCursor->getPlanSummaryStr();
}
return "";
}
void PlanExplainerPipeline::getSummaryStats(PlanSummaryStats* statsOut) const {
invariant(statsOut);
if (auto docSourceCursor =
dynamic_cast<DocumentSourceCursor*>(_pipeline->getSources().front().get())) {
*statsOut = docSourceCursor->getPlanSummaryStats();
}
for (auto&& source : _pipeline->getSources()) {
statsOut->usedDisk = statsOut->usedDisk || source->usedDisk();
if (dynamic_cast<DocumentSourceSort*>(source.get())) {
statsOut->hasSortStage = true;
} else if (auto docSourceLookUp = dynamic_cast<DocumentSourceLookUp*>(source.get())) {
collectPlanSummaryStats<DocumentSourceLookUp, DocumentSourceLookupStats>(
*docSourceLookUp, statsOut);
} else if (auto docSourceUnionWith = dynamic_cast<DocumentSourceUnionWith*>(source.get())) {
collectPlanSummaryStats<DocumentSourceUnionWith, UnionWithStats>(*docSourceUnionWith,
statsOut);
} else if (auto docSourceFacet = dynamic_cast<DocumentSourceFacet*>(source.get())) {
collectPlanSummaryStats<DocumentSourceFacet, DocumentSourceFacetStats>(*docSourceFacet,
statsOut);
}
}
if (_nReturned) {
statsOut->nReturned = _nReturned;
}
}
PlanExplainer::PlanStatsDetails PlanExplainerPipeline::getWinningPlanStats(
ExplainOptions::Verbosity verbosity) const {
// TODO SERVER-49808: Report execution stats for the pipeline.
return {};
}
PlanExplainer::PlanStatsDetails PlanExplainerPipeline::getWinningPlanTrialStats() const {
// We are not supposed to call this method on a pipeline explainer.
MONGO_UNREACHABLE;
}
std::vector<PlanExplainer::PlanStatsDetails> PlanExplainerPipeline::getRejectedPlansStats(
ExplainOptions::Verbosity verbosity) const {
// Multi-planning is not supported for aggregation pipelines.
return {};
}
std::vector<PlanExplainer::PlanStatsDetails> PlanExplainerPipeline::getCachedPlanStats(
const plan_cache_debug_info::DebugInfo&, ExplainOptions::Verbosity) const {
// Pipelines are not cached, so we should never try to rebuild the stats from a cached entry.
MONGO_UNREACHABLE;
}
} // namespace mongo
|
