blob: 30a9fd1440818c26e9cf175b014412a21b198726 (
plain)
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
|
/**
* Copyright (C) 2008 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.
*/
#pragma once
#include "mongo/db/projection.h"
namespace mongo {
class FieldRangeSet;
/**
* A partial description of a QueryPlan that provides access to relevant plan attributes outside
* of query optimizer internal code.
*/
struct QueryPlanSummary {
QueryPlanSummary() :
scanAndOrderRequired() {
}
/**
* The 'fieldRangeMulti' attribute is required, and its presence indicates the object has
* been configured with a query plan.
*/
bool valid() const { return fieldRangeSetMulti; }
// A description of the valid values for the fields of a query, in the context of a multikey
// index or in memory sort.
shared_ptr<FieldRangeSet> fieldRangeSetMulti;
// A helper object used to implement covered index queries. This attribute is only non-NULL
// if the query plan supports covered index queries.
shared_ptr<Projection::KeyOnly> keyFieldsOnly;
// True if the query plan results must be reordered to match a requested ordering.
bool scanAndOrderRequired;
};
} // namespace mongo
|
