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
|
/**
* Copyright (C) 2013 10gen 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.
*/
// THIS FILE IS DEPRECATED -- the old explain implementation is being replaced
#pragma once
#include "mongo/base/status.h"
#include "mongo/db/exec/plan_stats.h"
#include "mongo/db/query/query_solution.h"
namespace mongo {
class TypeExplain;
struct PlanInfo;
/**
* Returns OK, allocating and filling in '*explainOut' describing the access paths used in
* the 'stats' tree of a given query solution. The caller has the ownership of
* '*explainOut', on success. Otherwise return an error status describing the problem.
*
* If 'fullDetails' was requested, the explain will return all available information about
* the plan, otherwise, just a summary. The fields in the summary are: 'cursor', 'n',
* 'nscannedObjects', 'nscanned', and 'indexBounds'. The remaining fields are: 'isMultKey',
* 'nscannedObjectsAllPlans', 'nscannedAllPlans', 'scanAndOrder', 'indexOnly', 'nYields',
* 'nChunkSkips', 'millis', 'allPlans', and 'oldPlan'.
*
* All these fields are documented in type_explain.h
*
* TODO: This is temporarily in place to support the legacy explain format. Once legacy
* explain is removed, this function should be deleted.
*/
Status explainPlan(const PlanStageStats& stats, TypeExplain** explainOut, bool fullDetails);
} // namespace mongo
|
