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
|
/**
* 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.
*/
#pragma once
#include "mongo/db/exec/sbe/expressions/expression.h"
#include "mongo/db/exec/sbe/stages/collection_helpers.h"
#include "mongo/db/exec/sbe/stages/stages.h"
#include "mongo/db/exec/sbe/values/value.h"
#include "mongo/db/query/query_solution.h"
#include "mongo/db/query/sbe_stage_builder_helpers.h"
namespace mongo::stage_builder {
class PlanStageReqs;
class PlanStageSlots;
/**
* A list of low and high key values representing ranges over a particular index.
*/
using IndexIntervals =
std::vector<std::pair<std::unique_ptr<KeyString::Value>, std::unique_ptr<KeyString::Value>>>;
/**
* This method returns a pair containing: (1) an SBE plan stage tree implementing an index scan;
* and (2) a PlanStageSlots object containing a kRecordId slot, possibly some other kMeta slots,
* and slots produced by the index scan that correspond to parts of the index key specified by
* the 'indexKeyBitset' bitset.
*/
std::pair<std::unique_ptr<sbe::PlanStage>, PlanStageSlots> generateIndexScan(
StageBuilderState& state,
const CollectionPtr& collection,
const IndexScanNode* ixn,
const sbe::IndexKeysInclusionSet& indexKeyBitset,
PlanYieldPolicy* yieldPolicy,
StringMap<const IndexAccessMethod*>* iamMap,
bool needsCorruptionCheck);
/**
* Constructs low/high key values from the given index 'bounds' if they can be represented either as
* a single interval between the low and high keys, or multiple single intervals. If index bounds
* for some interval cannot be expressed as valid low/high keys, then an empty vector is returned.
*/
IndexIntervals makeIntervalsFromIndexBounds(const IndexBounds& bounds,
bool forward,
KeyString::Version version,
Ordering ordering);
/**
* Construct an array containing objects with the low and high keys for each interval.
*
* E.g., [ {l: KS(...), h: KS(...)},
* {l: KS(...), h: KS(...)}, ... ]
*/
std::pair<sbe::value::TypeTags, sbe::value::Value> packIndexIntervalsInSbeArray(
IndexIntervals intervals);
/**
* Constructs a generic multi-interval index scan. Depending on the intervals will either execute
* the optimized or the generic index scan subplan.
*
* This method returns a pair containing: (1) an SBE plan stage tree implementing a generic multi-
* interval index scan; and (2) a PlanStageSlots object containing a kRecordId slot, possibly some
* other kMeta slots, and slots produced by the index scan that correspond to parts of the index
* key specified by the 'indexKeyBitset' bitset.
*/
std::pair<std::unique_ptr<sbe::PlanStage>, PlanStageSlots> generateIndexScanWithDynamicBounds(
StageBuilderState& state,
const CollectionPtr& collection,
const IndexScanNode* ixn,
const sbe::IndexKeysInclusionSet& indexKeyBitset,
PlanYieldPolicy* yieldPolicy,
StringMap<const IndexAccessMethod*>* iamMap,
bool needsCorruptionCheck);
} // namespace mongo::stage_builder
|
