aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/clickhouse/src/Analyzer/Passes/SumIfToCountIfPass.cpp
blob: cff9ba1111c23fc10aef90f6e3f8641a9c8514e7 (plain) (blame)
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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
#include <Analyzer/Passes/SumIfToCountIfPass.h>

#include <DataTypes/DataTypesNumber.h>
#include <DataTypes/DataTypeNullable.h>

#include <AggregateFunctions/AggregateFunctionFactory.h>
#include <AggregateFunctions/IAggregateFunction.h>

#include <Functions/FunctionFactory.h>

#include <Interpreters/Context.h>

#include <Analyzer/InDepthQueryTreeVisitor.h>
#include <Analyzer/ConstantNode.h>
#include <Analyzer/FunctionNode.h>

namespace DB
{

namespace
{

class SumIfToCountIfVisitor : public InDepthQueryTreeVisitorWithContext<SumIfToCountIfVisitor>
{
public:
    using Base = InDepthQueryTreeVisitorWithContext<SumIfToCountIfVisitor>;
    using Base::Base;

    void enterImpl(QueryTreeNodePtr & node)
    {
        if (!getSettings().optimize_rewrite_sum_if_to_count_if)
            return;

        auto * function_node = node->as<FunctionNode>();
        if (!function_node || !function_node->isAggregateFunction())
            return;

        auto function_name = function_node->getFunctionName();
        auto lower_function_name = Poco::toLower(function_name);

        /// sumIf, SumIf or sUMIf are valid function names, but sumIF or sumiF are not
        if (lower_function_name != "sum" && (lower_function_name != "sumif" || !function_name.ends_with("If")))
            return;

        auto & function_node_arguments_nodes = function_node->getArguments().getNodes();

        /// Rewrite `sumIf(1, cond)` into `countIf(cond)`
        if (lower_function_name == "sumif")
        {
            if (function_node_arguments_nodes.size() != 2)
                return;

            const auto * constant_node = function_node_arguments_nodes[0]->as<ConstantNode>();
            if (!constant_node)
                return;

            const auto & constant_value_literal = constant_node->getValue();
            if (!isInt64OrUInt64FieldType(constant_value_literal.getType()))
                return;

            if (getSettings().aggregate_functions_null_for_empty)
                return;

            /// Rewrite `sumIf(1, cond)` into `countIf(cond)`
            auto multiplier_node = function_node_arguments_nodes[0];
            function_node_arguments_nodes[0] = std::move(function_node_arguments_nodes[1]);
            function_node_arguments_nodes.resize(1);
            resolveAsCountIfAggregateFunction(*function_node, function_node_arguments_nodes[0]->getResultType());

            if (constant_value_literal.get<UInt64>() != 1)
            {
                /// Rewrite `sumIf(123, cond)` into `123 * countIf(cond)`
                node = getMultiplyFunction(std::move(multiplier_node), node);
            }
            return;
        }

        /** Rewrite `sum(if(cond, 1, 0))` into `countIf(cond)`.
          * Rewrite `sum(if(cond, 0, 1))` into `countIf(not(cond))`.
          */
        if (function_node_arguments_nodes.size() != 1)
            return;

        auto & nested_argument = function_node_arguments_nodes[0];
        auto * nested_function = nested_argument->as<FunctionNode>();
        if (!nested_function || nested_function->getFunctionName() != "if")
            return;

        const auto nested_if_function_arguments_nodes = nested_function->getArguments().getNodes();
        if (nested_if_function_arguments_nodes.size() != 3)
            return;

        const auto & cond_argument = nested_if_function_arguments_nodes[0];
        const auto * if_true_condition_constant_node = nested_if_function_arguments_nodes[1]->as<ConstantNode>();
        const auto * if_false_condition_constant_node = nested_if_function_arguments_nodes[2]->as<ConstantNode>();

        if (!if_true_condition_constant_node || !if_false_condition_constant_node)
            return;

        const auto & if_true_condition_constant_value_literal = if_true_condition_constant_node->getValue();
        const auto & if_false_condition_constant_value_literal = if_false_condition_constant_node->getValue();

        if (!isInt64OrUInt64FieldType(if_true_condition_constant_value_literal.getType()) ||
            !isInt64OrUInt64FieldType(if_false_condition_constant_value_literal.getType()))
            return;

        auto if_true_condition_value = if_true_condition_constant_value_literal.get<UInt64>();
        auto if_false_condition_value = if_false_condition_constant_value_literal.get<UInt64>();

        if (if_false_condition_value == 0)
        {
            /// Rewrite `sum(if(cond, 1, 0))` into `countIf(cond)`.
            function_node_arguments_nodes[0] = nested_if_function_arguments_nodes[0];
            function_node_arguments_nodes.resize(1);

            resolveAsCountIfAggregateFunction(*function_node, function_node_arguments_nodes[0]->getResultType());

            if (if_true_condition_value != 1)
            {
                /// Rewrite `sum(if(cond, 123, 0))` into `123 * countIf(cond)`.
                node = getMultiplyFunction(nested_if_function_arguments_nodes[1], node);
            }
            return;
        }

        if (if_true_condition_value == 0 && !cond_argument->getResultType()->isNullable())
        {
            /// Rewrite `sum(if(cond, 0, 1))` into `countIf(not(cond))` if condition is not Nullable (otherwise the result can be different).
            DataTypePtr not_function_result_type = std::make_shared<DataTypeUInt8>();

            const auto & condition_result_type = nested_if_function_arguments_nodes[0]->getResultType();
            if (condition_result_type->isNullable())
                not_function_result_type = makeNullable(not_function_result_type);

            auto not_function = std::make_shared<FunctionNode>("not");

            auto & not_function_arguments = not_function->getArguments().getNodes();
            not_function_arguments.push_back(nested_if_function_arguments_nodes[0]);

            not_function->resolveAsFunction(FunctionFactory::instance().get("not", getContext())->build(not_function->getArgumentColumns()));

            function_node_arguments_nodes[0] = std::move(not_function);
            function_node_arguments_nodes.resize(1);

            resolveAsCountIfAggregateFunction(*function_node, function_node_arguments_nodes[0]->getResultType());

            if (if_false_condition_value != 1)
            {
                /// Rewrite `sum(if(cond, 0, 123))` into `123 * countIf(not(cond))` if condition is not Nullable (otherwise the result can be different).
                node = getMultiplyFunction(nested_if_function_arguments_nodes[2], node);
            }
            return;
        }
    }

private:
    static inline void resolveAsCountIfAggregateFunction(FunctionNode & function_node, const DataTypePtr & argument_type)
    {
        AggregateFunctionProperties properties;
        auto aggregate_function = AggregateFunctionFactory::instance().get("countIf",
            {argument_type},
            function_node.getAggregateFunction()->getParameters(),
            properties);

        function_node.resolveAsAggregateFunction(std::move(aggregate_function));
    }

    inline QueryTreeNodePtr getMultiplyFunction(QueryTreeNodePtr left, QueryTreeNodePtr right)
    {
        auto multiply_function_node = std::make_shared<FunctionNode>("multiply");
        auto & multiply_arguments_nodes = multiply_function_node->getArguments().getNodes();
        multiply_arguments_nodes.push_back(std::move(left));
        multiply_arguments_nodes.push_back(std::move(right));

        auto multiply_function_base = FunctionFactory::instance().get("multiply", getContext())->build(multiply_function_node->getArgumentColumns());
        multiply_function_node->resolveAsFunction(std::move(multiply_function_base));
        return std::move(multiply_function_node);
    }
};

}

void SumIfToCountIfPass::run(QueryTreeNodePtr query_tree_node, ContextPtr context)
{
    SumIfToCountIfVisitor visitor(context);
    visitor.visit(query_tree_node);
}

}