Coverage Report

Created: 2026-03-19 00:31

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
be/src/exprs/function/function_helpers.h
Line
Count
Source
1
// Licensed to the Apache Software Foundation (ASF) under one
2
// or more contributor license agreements.  See the NOTICE file
3
// distributed with this work for additional information
4
// regarding copyright ownership.  The ASF licenses this file
5
// to you under the Apache License, Version 2.0 (the
6
// "License"); you may not use this file except in compliance
7
// with the License.  You may obtain a copy of the License at
8
//
9
//   http://www.apache.org/licenses/LICENSE-2.0
10
//
11
// Unless required by applicable law or agreed to in writing,
12
// software distributed under the License is distributed on an
13
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14
// KIND, either express or implied.  See the License for the
15
// specific language governing permissions and limitations
16
// under the License.
17
// This file is copied from
18
// https://github.com/ClickHouse/ClickHouse/blob/master/src/Functions/FunctionHelpers.h
19
// and modified by Doris
20
21
#pragma once
22
23
#include <cstddef>
24
#include <tuple>
25
26
#include "core/assert_cast.h"
27
#include "core/block/block.h"
28
#include "core/block/column_numbers.h"
29
#include "core/column/column.h"
30
#include "core/column/column_const.h"
31
#include "core/data_type/data_type.h"
32
#include "core/field.h"
33
#include "core/typeid_cast.h"
34
#include "core/types.h"
35
36
namespace doris {
37
38
class IFunction;
39
40
/// Methods, that helps dispatching over real column types.
41
42
template <typename... Type>
43
bool check_data_type(const IDataType* data_type) {
44
    return ((typeid_cast<const Type*>(data_type)) || ...);
45
}
46
47
template <typename Type>
48
271k
const Type* check_and_get_data_type(const IDataType* data_type) {
49
271k
    return typeid_cast<const Type*>(data_type);
50
271k
}
_ZN5doris23check_and_get_data_typeINS_14DataTypeStringEEEPKT_PKNS_9IDataTypeE
Line
Count
Source
48
135k
const Type* check_and_get_data_type(const IDataType* data_type) {
49
135k
    return typeid_cast<const Type*>(data_type);
50
135k
}
_ZN5doris23check_and_get_data_typeINS_13DataTypeArrayEEEPKT_PKNS_9IDataTypeE
Line
Count
Source
48
69.6k
const Type* check_and_get_data_type(const IDataType* data_type) {
49
69.6k
    return typeid_cast<const Type*>(data_type);
50
69.6k
}
_ZN5doris23check_and_get_data_typeINS_11DataTypeMapEEEPKT_PKNS_9IDataTypeE
Line
Count
Source
48
2.57k
const Type* check_and_get_data_type(const IDataType* data_type) {
49
2.57k
    return typeid_cast<const Type*>(data_type);
50
2.57k
}
_ZN5doris23check_and_get_data_typeINS_14DataTypeStructEEEPKT_PKNS_9IDataTypeE
Line
Count
Source
48
9.62k
const Type* check_and_get_data_type(const IDataType* data_type) {
49
9.62k
    return typeid_cast<const Type*>(data_type);
50
9.62k
}
_ZN5doris23check_and_get_data_typeINS_15DataTypeDecimalILNS_13PrimitiveTypeE28EEEEEPKT_PKNS_9IDataTypeE
Line
Count
Source
48
9.08k
const Type* check_and_get_data_type(const IDataType* data_type) {
49
9.08k
    return typeid_cast<const Type*>(data_type);
50
9.08k
}
_ZN5doris23check_and_get_data_typeINS_15DataTypeDecimalILNS_13PrimitiveTypeE29EEEEEPKT_PKNS_9IDataTypeE
Line
Count
Source
48
15.9k
const Type* check_and_get_data_type(const IDataType* data_type) {
49
15.9k
    return typeid_cast<const Type*>(data_type);
50
15.9k
}
_ZN5doris23check_and_get_data_typeINS_15DataTypeDecimalILNS_13PrimitiveTypeE20EEEEEPKT_PKNS_9IDataTypeE
Line
Count
Source
48
1.46k
const Type* check_and_get_data_type(const IDataType* data_type) {
49
1.46k
    return typeid_cast<const Type*>(data_type);
50
1.46k
}
_ZN5doris23check_and_get_data_typeINS_15DataTypeDecimalILNS_13PrimitiveTypeE30EEEEEPKT_PKNS_9IDataTypeE
Line
Count
Source
48
17.9k
const Type* check_and_get_data_type(const IDataType* data_type) {
49
17.9k
    return typeid_cast<const Type*>(data_type);
50
17.9k
}
_ZN5doris23check_and_get_data_typeINS_15DataTypeDecimalILNS_13PrimitiveTypeE35EEEEEPKT_PKNS_9IDataTypeE
Line
Count
Source
48
9.74k
const Type* check_and_get_data_type(const IDataType* data_type) {
49
9.74k
    return typeid_cast<const Type*>(data_type);
50
9.74k
}
51
52
template <typename Type>
53
19.0k
const ColumnConst* check_and_get_column_const(const IColumn* column) {
54
19.0k
    if (!column || !is_column_const(*column)) {
55
6.84k
        return nullptr;
56
6.84k
    }
57
58
12.2k
    const auto* res = assert_cast<const ColumnConst*, TypeCheckOnRelease::DISABLE>(column);
59
60
12.2k
    if (!is_column<Type>(&res->get_data_column())) {
61
0
        return nullptr;
62
0
    }
63
64
12.2k
    return res;
65
12.2k
}
_ZN5doris26check_and_get_column_constINS_12ColumnVectorILNS_13PrimitiveTypeE8EEEEEPKNS_11ColumnConstEPKNS_7IColumnE
Line
Count
Source
53
309
const ColumnConst* check_and_get_column_const(const IColumn* column) {
54
309
    if (!column || !is_column_const(*column)) {
55
93
        return nullptr;
56
93
    }
57
58
216
    const auto* res = assert_cast<const ColumnConst*, TypeCheckOnRelease::DISABLE>(column);
59
60
216
    if (!is_column<Type>(&res->get_data_column())) {
61
0
        return nullptr;
62
0
    }
63
64
216
    return res;
65
216
}
_ZN5doris26check_and_get_column_constINS_13ColumnDecimalILNS_13PrimitiveTypeE28EEEEEPKNS_11ColumnConstEPKNS_7IColumnE
Line
Count
Source
53
120
const ColumnConst* check_and_get_column_const(const IColumn* column) {
54
120
    if (!column || !is_column_const(*column)) {
55
0
        return nullptr;
56
0
    }
57
58
120
    const auto* res = assert_cast<const ColumnConst*, TypeCheckOnRelease::DISABLE>(column);
59
60
120
    if (!is_column<Type>(&res->get_data_column())) {
61
0
        return nullptr;
62
0
    }
63
64
120
    return res;
65
120
}
_ZN5doris26check_and_get_column_constINS_13ColumnDecimalILNS_13PrimitiveTypeE29EEEEEPKNS_11ColumnConstEPKNS_7IColumnE
Line
Count
Source
53
6.87k
const ColumnConst* check_and_get_column_const(const IColumn* column) {
54
6.87k
    if (!column || !is_column_const(*column)) {
55
0
        return nullptr;
56
0
    }
57
58
6.87k
    const auto* res = assert_cast<const ColumnConst*, TypeCheckOnRelease::DISABLE>(column);
59
60
6.87k
    if (!is_column<Type>(&res->get_data_column())) {
61
0
        return nullptr;
62
0
    }
63
64
6.87k
    return res;
65
6.87k
}
Unexecuted instantiation: _ZN5doris26check_and_get_column_constINS_13ColumnDecimalILNS_13PrimitiveTypeE20EEEEEPKNS_11ColumnConstEPKNS_7IColumnE
_ZN5doris26check_and_get_column_constINS_13ColumnDecimalILNS_13PrimitiveTypeE30EEEEEPKNS_11ColumnConstEPKNS_7IColumnE
Line
Count
Source
53
3.81k
const ColumnConst* check_and_get_column_const(const IColumn* column) {
54
3.81k
    if (!column || !is_column_const(*column)) {
55
0
        return nullptr;
56
0
    }
57
58
3.81k
    const auto* res = assert_cast<const ColumnConst*, TypeCheckOnRelease::DISABLE>(column);
59
60
3.81k
    if (!is_column<Type>(&res->get_data_column())) {
61
0
        return nullptr;
62
0
    }
63
64
3.81k
    return res;
65
3.81k
}
_ZN5doris26check_and_get_column_constINS_13ColumnDecimalILNS_13PrimitiveTypeE35EEEEEPKNS_11ColumnConstEPKNS_7IColumnE
Line
Count
Source
53
54
const ColumnConst* check_and_get_column_const(const IColumn* column) {
54
54
    if (!column || !is_column_const(*column)) {
55
0
        return nullptr;
56
0
    }
57
58
54
    const auto* res = assert_cast<const ColumnConst*, TypeCheckOnRelease::DISABLE>(column);
59
60
54
    if (!is_column<Type>(&res->get_data_column())) {
61
0
        return nullptr;
62
0
    }
63
64
54
    return res;
65
54
}
_ZN5doris26check_and_get_column_constINS_12ColumnVectorILNS_13PrimitiveTypeE2EEEEEPKNS_11ColumnConstEPKNS_7IColumnE
Line
Count
Source
53
1.24k
const ColumnConst* check_and_get_column_const(const IColumn* column) {
54
1.24k
    if (!column || !is_column_const(*column)) {
55
1.15k
        return nullptr;
56
1.15k
    }
57
58
91
    const auto* res = assert_cast<const ColumnConst*, TypeCheckOnRelease::DISABLE>(column);
59
60
91
    if (!is_column<Type>(&res->get_data_column())) {
61
0
        return nullptr;
62
0
    }
63
64
91
    return res;
65
91
}
_ZN5doris26check_and_get_column_constINS_12ColumnVectorILNS_13PrimitiveTypeE3EEEEEPKNS_11ColumnConstEPKNS_7IColumnE
Line
Count
Source
53
736
const ColumnConst* check_and_get_column_const(const IColumn* column) {
54
736
    if (!column || !is_column_const(*column)) {
55
0
        return nullptr;
56
0
    }
57
58
736
    const auto* res = assert_cast<const ColumnConst*, TypeCheckOnRelease::DISABLE>(column);
59
60
736
    if (!is_column<Type>(&res->get_data_column())) {
61
0
        return nullptr;
62
0
    }
63
64
736
    return res;
65
736
}
_ZN5doris26check_and_get_column_constINS_12ColumnVectorILNS_13PrimitiveTypeE4EEEEEPKNS_11ColumnConstEPKNS_7IColumnE
Line
Count
Source
53
4
const ColumnConst* check_and_get_column_const(const IColumn* column) {
54
4
    if (!column || !is_column_const(*column)) {
55
0
        return nullptr;
56
0
    }
57
58
4
    const auto* res = assert_cast<const ColumnConst*, TypeCheckOnRelease::DISABLE>(column);
59
60
4
    if (!is_column<Type>(&res->get_data_column())) {
61
0
        return nullptr;
62
0
    }
63
64
4
    return res;
65
4
}
_ZN5doris26check_and_get_column_constINS_12ColumnVectorILNS_13PrimitiveTypeE5EEEEEPKNS_11ColumnConstEPKNS_7IColumnE
Line
Count
Source
53
43
const ColumnConst* check_and_get_column_const(const IColumn* column) {
54
43
    if (!column || !is_column_const(*column)) {
55
0
        return nullptr;
56
0
    }
57
58
43
    const auto* res = assert_cast<const ColumnConst*, TypeCheckOnRelease::DISABLE>(column);
59
60
43
    if (!is_column<Type>(&res->get_data_column())) {
61
0
        return nullptr;
62
0
    }
63
64
43
    return res;
65
43
}
_ZN5doris26check_and_get_column_constINS_12ColumnVectorILNS_13PrimitiveTypeE6EEEEEPKNS_11ColumnConstEPKNS_7IColumnE
Line
Count
Source
53
156
const ColumnConst* check_and_get_column_const(const IColumn* column) {
54
156
    if (!column || !is_column_const(*column)) {
55
0
        return nullptr;
56
0
    }
57
58
156
    const auto* res = assert_cast<const ColumnConst*, TypeCheckOnRelease::DISABLE>(column);
59
60
156
    if (!is_column<Type>(&res->get_data_column())) {
61
0
        return nullptr;
62
0
    }
63
64
156
    return res;
65
156
}
_ZN5doris26check_and_get_column_constINS_12ColumnVectorILNS_13PrimitiveTypeE7EEEEEPKNS_11ColumnConstEPKNS_7IColumnE
Line
Count
Source
53
4
const ColumnConst* check_and_get_column_const(const IColumn* column) {
54
4
    if (!column || !is_column_const(*column)) {
55
0
        return nullptr;
56
0
    }
57
58
4
    const auto* res = assert_cast<const ColumnConst*, TypeCheckOnRelease::DISABLE>(column);
59
60
4
    if (!is_column<Type>(&res->get_data_column())) {
61
0
        return nullptr;
62
0
    }
63
64
4
    return res;
65
4
}
_ZN5doris26check_and_get_column_constINS_12ColumnVectorILNS_13PrimitiveTypeE9EEEEEPKNS_11ColumnConstEPKNS_7IColumnE
Line
Count
Source
53
25
const ColumnConst* check_and_get_column_const(const IColumn* column) {
54
25
    if (!column || !is_column_const(*column)) {
55
0
        return nullptr;
56
0
    }
57
58
25
    const auto* res = assert_cast<const ColumnConst*, TypeCheckOnRelease::DISABLE>(column);
59
60
25
    if (!is_column<Type>(&res->get_data_column())) {
61
0
        return nullptr;
62
0
    }
63
64
25
    return res;
65
25
}
Unexecuted instantiation: _ZN5doris26check_and_get_column_constINS_12ColumnVectorILNS_13PrimitiveTypeE11EEEEEPKNS_11ColumnConstEPKNS_7IColumnE
_ZN5doris26check_and_get_column_constINS_12ColumnVectorILNS_13PrimitiveTypeE25EEEEEPKNS_11ColumnConstEPKNS_7IColumnE
Line
Count
Source
53
14
const ColumnConst* check_and_get_column_const(const IColumn* column) {
54
14
    if (!column || !is_column_const(*column)) {
55
0
        return nullptr;
56
0
    }
57
58
14
    const auto* res = assert_cast<const ColumnConst*, TypeCheckOnRelease::DISABLE>(column);
59
60
14
    if (!is_column<Type>(&res->get_data_column())) {
61
0
        return nullptr;
62
0
    }
63
64
14
    return res;
65
14
}
_ZN5doris26check_and_get_column_constINS_12ColumnVectorILNS_13PrimitiveTypeE26EEEEEPKNS_11ColumnConstEPKNS_7IColumnE
Line
Count
Source
53
71
const ColumnConst* check_and_get_column_const(const IColumn* column) {
54
71
    if (!column || !is_column_const(*column)) {
55
0
        return nullptr;
56
0
    }
57
58
71
    const auto* res = assert_cast<const ColumnConst*, TypeCheckOnRelease::DISABLE>(column);
59
60
71
    if (!is_column<Type>(&res->get_data_column())) {
61
0
        return nullptr;
62
0
    }
63
64
71
    return res;
65
71
}
Unexecuted instantiation: _ZN5doris26check_and_get_column_constINS_12ColumnVectorILNS_13PrimitiveTypeE12EEEEEPKNS_11ColumnConstEPKNS_7IColumnE
_ZN5doris26check_and_get_column_constINS_12ColumnVectorILNS_13PrimitiveTypeE27EEEEEPKNS_11ColumnConstEPKNS_7IColumnE
Line
Count
Source
53
4
const ColumnConst* check_and_get_column_const(const IColumn* column) {
54
4
    if (!column || !is_column_const(*column)) {
55
0
        return nullptr;
56
0
    }
57
58
4
    const auto* res = assert_cast<const ColumnConst*, TypeCheckOnRelease::DISABLE>(column);
59
60
4
    if (!is_column<Type>(&res->get_data_column())) {
61
0
        return nullptr;
62
0
    }
63
64
4
    return res;
65
4
}
Unexecuted instantiation: _ZN5doris26check_and_get_column_constINS_12ColumnVectorILNS_13PrimitiveTypeE42EEEEEPKNS_11ColumnConstEPKNS_7IColumnE
Unexecuted instantiation: _ZN5doris26check_and_get_column_constINS_12ColumnVectorILNS_13PrimitiveTypeE36EEEEEPKNS_11ColumnConstEPKNS_7IColumnE
Unexecuted instantiation: _ZN5doris26check_and_get_column_constINS_12ColumnVectorILNS_13PrimitiveTypeE37EEEEEPKNS_11ColumnConstEPKNS_7IColumnE
_ZN5doris26check_and_get_column_constINS_9ColumnMapEEEPKNS_11ColumnConstEPKNS_7IColumnE
Line
Count
Source
53
5.44k
const ColumnConst* check_and_get_column_const(const IColumn* column) {
54
5.44k
    if (!column || !is_column_const(*column)) {
55
5.44k
        return nullptr;
56
5.44k
    }
57
58
0
    const auto* res = assert_cast<const ColumnConst*, TypeCheckOnRelease::DISABLE>(column);
59
60
0
    if (!is_column<Type>(&res->get_data_column())) {
61
0
        return nullptr;
62
0
    }
63
64
0
    return res;
65
0
}
_ZN5doris26check_and_get_column_constINS_9ColumnStrIjEEEEPKNS_11ColumnConstEPKNS_7IColumnE
Line
Count
Source
53
77
const ColumnConst* check_and_get_column_const(const IColumn* column) {
54
77
    if (!column || !is_column_const(*column)) {
55
77
        return nullptr;
56
77
    }
57
58
0
    const auto* res = assert_cast<const ColumnConst*, TypeCheckOnRelease::DISABLE>(column);
59
60
0
    if (!is_column<Type>(&res->get_data_column())) {
61
0
        return nullptr;
62
0
    }
63
64
0
    return res;
65
0
}
_ZN5doris26check_and_get_column_constINS_11ColumnArrayEEEPKNS_11ColumnConstEPKNS_7IColumnE
Line
Count
Source
53
77
const ColumnConst* check_and_get_column_const(const IColumn* column) {
54
77
    if (!column || !is_column_const(*column)) {
55
71
        return nullptr;
56
71
    }
57
58
6
    const auto* res = assert_cast<const ColumnConst*, TypeCheckOnRelease::DISABLE>(column);
59
60
6
    if (!is_column<Type>(&res->get_data_column())) {
61
0
        return nullptr;
62
0
    }
63
64
6
    return res;
65
6
}
66
67
template <typename Type>
68
const Type* check_and_get_column_constData(const IColumn* column) {
69
    const ColumnConst* res = check_and_get_column_const<Type>(column);
70
71
    if (!res) {
72
        return nullptr;
73
    }
74
75
    return static_cast<const Type*>(&res->get_data_column());
76
}
77
78
template <typename Type>
79
5.44k
bool check_column_const(const IColumn* column) {
80
5.44k
    return check_and_get_column_const<Type>(column);
81
5.44k
}
82
83
/// Returns non-nullptr if column is ColumnConst with ColumnString or ColumnFixedString inside.
84
const ColumnConst* check_and_get_column_const_string_or_fixedstring(const IColumn* column);
85
86
/// Transform anything to Field.
87
template <PrimitiveType T>
88
    requires(!is_decimal(T))
89
176
Field to_field(const typename PrimitiveTypeTraits<T>::CppType& x) {
90
176
    return Field::create_field<T>(typename PrimitiveTypeTraits<T>::CppType(x));
91
176
}
Unexecuted instantiation: _ZN5doris8to_fieldILNS_13PrimitiveTypeE2EQntclL_ZNS_10is_decimalES1_ET_EEENS_5FieldERKNS_19PrimitiveTypeTraitsIXT_EE7CppTypeE
_ZN5doris8to_fieldILNS_13PrimitiveTypeE5EQntclL_ZNS_10is_decimalES1_ET_EEENS_5FieldERKNS_19PrimitiveTypeTraitsIXT_EE7CppTypeE
Line
Count
Source
89
176
Field to_field(const typename PrimitiveTypeTraits<T>::CppType& x) {
90
176
    return Field::create_field<T>(typename PrimitiveTypeTraits<T>::CppType(x));
91
176
}
92
93
template <PrimitiveType T>
94
    requires(is_decimal(T))
95
Field to_field(const typename PrimitiveTypeTraits<T>::CppType& x, UInt32 scale) {
96
    return Field::create_field<T>(typename PrimitiveTypeTraits<T>::CppType(x, scale));
97
}
98
99
Columns convert_const_tuple_to_constant_elements(const ColumnConst& column);
100
101
/// Returns the copy of a tmp block and temp args order same as args
102
/// in which only args column each column specified in the "arguments"
103
/// parameter is replaced with its respective nested column if it is nullable.
104
std::tuple<Block, ColumnNumbers> create_block_with_nested_columns(const Block& block,
105
                                                                  const ColumnNumbers& args,
106
                                                                  const bool need_check_same);
107
108
// Same as above and return the new_res loc in tuple
109
std::tuple<Block, ColumnNumbers, size_t> create_block_with_nested_columns(const Block& block,
110
                                                                          const ColumnNumbers& args,
111
                                                                          uint32_t result);
112
113
/// Checks argument type at specified index with predicate.
114
/// throws if there is no argument at specified index or if predicate returns false.
115
void validate_argument_type(const IFunction& func, const DataTypes& arguments,
116
                            size_t argument_index, bool (*validator_func)(const IDataType&),
117
                            const char* expected_type_description);
118
119
} // namespace doris