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
|
/**
* 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.
*/
#pragma once
#include <vector>
#include "mongo/db/jsobj.h"
#include "mongo/db/query/index_entry.h"
#include "mongo/db/query/query_knobs_gen.h"
namespace mongo {
struct QueryPlannerParams {
QueryPlannerParams()
: options(DEFAULT),
indexFiltersApplied(false),
maxIndexedSolutions(internalQueryPlannerMaxIndexedSolutions.load()) {}
enum Options {
// You probably want to set this.
DEFAULT = 0,
// Set this if you don't want a table scan.
// See http://docs.mongodb.org/manual/reference/parameters/
NO_TABLE_SCAN = 1,
// Set this if you *always* want a collscan outputted, even if there's an ixscan. This
// makes ranking less accurate, especially in the presence of blocking stages.
INCLUDE_COLLSCAN = 1 << 1,
// Set this if you're running on a sharded cluster. We'll add a "drop all docs that
// shouldn't be on this shard" stage before projection.
//
// In order to set this, you must check OperationShardingState::isOperationVersioned() in
// the same lock that you use to build the query executor. You must also wrap the
// PlanExecutor in a ClientCursor within the same lock.
//
// See the comment on ShardFilterStage for details.
INCLUDE_SHARD_FILTER = 1 << 2,
// Set this if you don't want any plans with a blocking sort stage. All sorts must be
// provided by an index.
NO_BLOCKING_SORT = 1 << 3,
// Set this if you want to turn on index intersection.
INDEX_INTERSECTION = 1 << 4,
// Indicate to the planner that the caller is requesting a count operation, possibly through
// a count command, or as part of an aggregation pipeline.
IS_COUNT = 1 << 5,
// Set this if you want to handle batchSize properly with sort(). If limits on SORT
// stages are always actually limits, then this should be left off. If they are
// sometimes to be interpreted as batchSize, then this should be turned on.
SPLIT_LIMITED_SORT = 1 << 6,
// Set this if you don't want any plans with a non-covered projection stage. All projections
// must be provided/covered by an index.
NO_UNCOVERED_PROJECTIONS = 1 << 7,
// Set this to generate covered whole IXSCAN plans.
GENERATE_COVERED_IXSCANS = 1 << 8,
// Set this to track the most recent timestamp seen by this cursor while scanning the oplog.
TRACK_LATEST_OPLOG_TS = 1 << 9,
// Set this so that collection scans on the oplog wait for visibility before reading.
OPLOG_SCAN_WAIT_FOR_VISIBLE = 1 << 10,
// Set this so that getExecutorDistinct() will only use a plan that _guarantees_ it will
// return exactly one document per value of the distinct field. See the comments above the
// declaration of getExecutorDistinct() for more detail.
STRICT_DISTINCT_ONLY = 1 << 11,
};
// See Options enum above.
size_t options;
// What indices are available for planning?
std::vector<IndexEntry> indices;
// What's our shard key? If INCLUDE_SHARD_FILTER is set we will create a shard filtering
// stage. If we know the shard key, we can perform covering analysis instead of always
// forcing a fetch.
BSONObj shardKey;
// Were index filters applied to indices?
bool indexFiltersApplied;
// What's the max number of indexed solutions we want to output? It's expensive to compare
// plans via the MultiPlanStage, and the set of possible plans is very large for certain
// index+query combinations.
size_t maxIndexedSolutions;
};
} // namespace mongo
|
