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
127
128
129
|
/**
* Copyright (C) 2022-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/query/optimizer/defs.h"
#include "mongo/db/query/optimizer/index_bounds.h"
#include "mongo/db/query/stats/array_histogram.h"
namespace mongo::optimizer::ce {
enum class EstimationType { kEqual, kLess, kLessOrEqual, kGreater, kGreaterOrEqual };
enum class EstimationAlgo { HistogramV1, HistogramV2, HistogramV3 };
const stdx::unordered_map<EstimationType, std::string> estimationTypeName = {
{EstimationType::kEqual, "eq"},
{EstimationType::kLess, "lt"},
{EstimationType::kLessOrEqual, "lte"},
{EstimationType::kGreater, "gt"},
{EstimationType::kGreaterOrEqual, "gte"}};
struct EstimationResult {
double card;
double ndv;
EstimationResult operator-(const EstimationResult& other) const {
return {card - other.card, ndv - other.ndv};
}
};
/**
* Converts an input cardinality to a selectivity based on the histogram's sample size.
*/
SelectivityType getSelectivity(const stats::ArrayHistogram& ah, CEType cardinality);
/**
* Returns the selectivity of arrays according to this histogram.
*/
SelectivityType getArraySelectivity(const stats::ArrayHistogram& ah);
/**
* Returns cumulative total statistics for a histogram.
*/
EstimationResult getTotals(const stats::ScalarHistogram& h);
/**
* Compute an estimate for a given value and estimation type. Use linear interpolation for values
* that fall inside of histogram buckets.
*/
EstimationResult estimate(const stats::ScalarHistogram& h,
sbe::value::TypeTags tag,
sbe::value::Value val,
EstimationType type);
/**
* Estimates the cardinality of an equality predicate given an ArrayHistogram and an SBE value and
* type tag pair.
*/
CEType estimateCardEq(const stats::ArrayHistogram& ah,
sbe::value::TypeTags tag,
sbe::value::Value val,
bool includeScalar);
/**
* Estimates the cardinality of a range predicate given an ArrayHistogram and a range predicate.
* Set 'includeScalar' to true to indicate whether or not the provided range should include no-array
* values. The other fields define the range of the estimation.
*/
CEType estimateCardRange(const stats::ArrayHistogram& ah,
bool lowInclusive,
sbe::value::TypeTags tagLow,
sbe::value::Value valLow,
bool highInclusive,
sbe::value::TypeTags tagHigh,
sbe::value::Value valHigh,
bool includeScalar,
EstimationAlgo estAlgo = EstimationAlgo::HistogramV2);
/**
* Estimates the selectivity of an equality predicate given an ArrayHistogram and an SBE value and
* type tag pair.
*/
SelectivityType estimateSelEq(const stats::ArrayHistogram& ah,
sbe::value::TypeTags tag,
sbe::value::Value val,
bool includeScalar);
/**
* Estimates the selectivity of a range predicate given an ArrayHistogram and a range predicate.
* Set 'includeScalar' to true to indicate whether or not the provided range should include no-array
* values. The other fields define the range of the estimation.
*/
SelectivityType estimateSelRange(const stats::ArrayHistogram& ah,
bool lowInclusive,
sbe::value::TypeTags tagLow,
sbe::value::Value valLow,
bool highInclusive,
sbe::value::TypeTags tagHigh,
sbe::value::Value valHigh,
bool includeScalar,
EstimationAlgo estAlgo = EstimationAlgo::HistogramV2);
} // namespace mongo::optimizer::ce
|
