Coverage Report

Created: 2026-06-27 17:44

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
498k
const Type* check_and_get_data_type(const IDataType* data_type) {
49
498k
    return typeid_cast<const Type*>(data_type);
50
498k
}
_ZN5doris23check_and_get_data_typeINS_11DataTypeMapEEEPKT_PKNS_9IDataTypeE
Line
Count
Source
48
3.17k
const Type* check_and_get_data_type(const IDataType* data_type) {
49
3.17k
    return typeid_cast<const Type*>(data_type);
50
3.17k
}
_ZN5doris23check_and_get_data_typeINS_14DataTypeStringEEEPKT_PKNS_9IDataTypeE
Line
Count
Source
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_13DataTypeArrayEEEPKT_PKNS_9IDataTypeE
Line
Count
Source
48
146k
const Type* check_and_get_data_type(const IDataType* data_type) {
49
146k
    return typeid_cast<const Type*>(data_type);
50
146k
}
_ZN5doris23check_and_get_data_typeINS_14DataTypeStructEEEPKT_PKNS_9IDataTypeE
Line
Count
Source
48
12.8k
const Type* check_and_get_data_type(const IDataType* data_type) {
49
12.8k
    return typeid_cast<const Type*>(data_type);
50
12.8k
}
_ZN5doris23check_and_get_data_typeINS_15DataTypeDecimalILNS_13PrimitiveTypeE28EEEEEPKT_PKNS_9IDataTypeE
Line
Count
Source
48
8.82k
const Type* check_and_get_data_type(const IDataType* data_type) {
49
8.82k
    return typeid_cast<const Type*>(data_type);
50
8.82k
}
_ZN5doris23check_and_get_data_typeINS_15DataTypeDecimalILNS_13PrimitiveTypeE29EEEEEPKT_PKNS_9IDataTypeE
Line
Count
Source
48
26.8k
const Type* check_and_get_data_type(const IDataType* data_type) {
49
26.8k
    return typeid_cast<const Type*>(data_type);
50
26.8k
}
_ZN5doris23check_and_get_data_typeINS_15DataTypeDecimalILNS_13PrimitiveTypeE20EEEEEPKT_PKNS_9IDataTypeE
Line
Count
Source
48
1.70k
const Type* check_and_get_data_type(const IDataType* data_type) {
49
1.70k
    return typeid_cast<const Type*>(data_type);
50
1.70k
}
_ZN5doris23check_and_get_data_typeINS_15DataTypeDecimalILNS_13PrimitiveTypeE30EEEEEPKT_PKNS_9IDataTypeE
Line
Count
Source
48
16.8k
const Type* check_and_get_data_type(const IDataType* data_type) {
49
16.8k
    return typeid_cast<const Type*>(data_type);
50
16.8k
}
_ZN5doris23check_and_get_data_typeINS_15DataTypeDecimalILNS_13PrimitiveTypeE35EEEEEPKT_PKNS_9IDataTypeE
Line
Count
Source
48
9.71k
const Type* check_and_get_data_type(const IDataType* data_type) {
49
9.71k
    return typeid_cast<const Type*>(data_type);
50
9.71k
}
_ZN5doris23check_and_get_data_typeINS_16DataTypeNullableEEEPKT_PKNS_9IDataTypeE
Line
Count
Source
48
144
const Type* check_and_get_data_type(const IDataType* data_type) {
49
144
    return typeid_cast<const Type*>(data_type);
50
144
}
51
52
template <typename Type>
53
158k
const ColumnConst* check_and_get_column_const(const IColumn* column) {
54
158k
    if (!column || !is_column_const(*column)) {
55
3.87k
        return nullptr;
56
3.87k
    }
57
58
154k
    const auto* res = assert_cast<const ColumnConst*, TypeCheckOnRelease::DISABLE>(column);
59
60
154k
    if (!is_column<Type>(&res->get_data_column())) {
61
0
        return nullptr;
62
0
    }
63
64
154k
    return res;
65
154k
}
_ZN5doris26check_and_get_column_constINS_12ColumnVectorILNS_13PrimitiveTypeE8EEEEEPKNS_11ColumnConstEPKNS_7IColumnE
Line
Count
Source
53
299
const ColumnConst* check_and_get_column_const(const IColumn* column) {
54
299
    if (!column || !is_column_const(*column)) {
55
87
        return nullptr;
56
87
    }
57
58
212
    const auto* res = assert_cast<const ColumnConst*, TypeCheckOnRelease::DISABLE>(column);
59
60
212
    if (!is_column<Type>(&res->get_data_column())) {
61
0
        return nullptr;
62
0
    }
63
64
212
    return res;
65
212
}
_ZN5doris26check_and_get_column_constINS_13ColumnDecimalILNS_13PrimitiveTypeE28EEEEEPKNS_11ColumnConstEPKNS_7IColumnE
Line
Count
Source
53
170
const ColumnConst* check_and_get_column_const(const IColumn* column) {
54
170
    if (!column || !is_column_const(*column)) {
55
0
        return nullptr;
56
0
    }
57
58
170
    const auto* res = assert_cast<const ColumnConst*, TypeCheckOnRelease::DISABLE>(column);
59
60
170
    if (!is_column<Type>(&res->get_data_column())) {
61
0
        return nullptr;
62
0
    }
63
64
170
    return res;
65
170
}
_ZN5doris26check_and_get_column_constINS_13ColumnDecimalILNS_13PrimitiveTypeE29EEEEEPKNS_11ColumnConstEPKNS_7IColumnE
Line
Count
Source
53
148k
const ColumnConst* check_and_get_column_const(const IColumn* column) {
54
148k
    if (!column || !is_column_const(*column)) {
55
0
        return nullptr;
56
0
    }
57
58
148k
    const auto* res = assert_cast<const ColumnConst*, TypeCheckOnRelease::DISABLE>(column);
59
60
148k
    if (!is_column<Type>(&res->get_data_column())) {
61
0
        return nullptr;
62
0
    }
63
64
148k
    return res;
65
148k
}
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.83k
const ColumnConst* check_and_get_column_const(const IColumn* column) {
54
3.83k
    if (!column || !is_column_const(*column)) {
55
0
        return nullptr;
56
0
    }
57
58
3.83k
    const auto* res = assert_cast<const ColumnConst*, TypeCheckOnRelease::DISABLE>(column);
59
60
3.83k
    if (!is_column<Type>(&res->get_data_column())) {
61
0
        return nullptr;
62
0
    }
63
64
3.83k
    return res;
65
3.83k
}
_ZN5doris26check_and_get_column_constINS_13ColumnDecimalILNS_13PrimitiveTypeE35EEEEEPKNS_11ColumnConstEPKNS_7IColumnE
Line
Count
Source
53
50
const ColumnConst* check_and_get_column_const(const IColumn* column) {
54
50
    if (!column || !is_column_const(*column)) {
55
0
        return nullptr;
56
0
    }
57
58
50
    const auto* res = assert_cast<const ColumnConst*, TypeCheckOnRelease::DISABLE>(column);
59
60
50
    if (!is_column<Type>(&res->get_data_column())) {
61
0
        return nullptr;
62
0
    }
63
64
50
    return res;
65
50
}
_ZN5doris26check_and_get_column_constINS_12ColumnVectorILNS_13PrimitiveTypeE2EEEEEPKNS_11ColumnConstEPKNS_7IColumnE
Line
Count
Source
53
3.86k
const ColumnConst* check_and_get_column_const(const IColumn* column) {
54
3.86k
    if (!column || !is_column_const(*column)) {
55
3.68k
        return nullptr;
56
3.68k
    }
57
58
182
    const auto* res = assert_cast<const ColumnConst*, TypeCheckOnRelease::DISABLE>(column);
59
60
182
    if (!is_column<Type>(&res->get_data_column())) {
61
0
        return nullptr;
62
0
    }
63
64
182
    return res;
65
182
}
_ZN5doris26check_and_get_column_constINS_12ColumnVectorILNS_13PrimitiveTypeE3EEEEEPKNS_11ColumnConstEPKNS_7IColumnE
Line
Count
Source
53
956
const ColumnConst* check_and_get_column_const(const IColumn* column) {
54
956
    if (!column || !is_column_const(*column)) {
55
0
        return nullptr;
56
0
    }
57
58
956
    const auto* res = assert_cast<const ColumnConst*, TypeCheckOnRelease::DISABLE>(column);
59
60
956
    if (!is_column<Type>(&res->get_data_column())) {
61
0
        return nullptr;
62
0
    }
63
64
956
    return res;
65
956
}
_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
141
const ColumnConst* check_and_get_column_const(const IColumn* column) {
54
141
    if (!column || !is_column_const(*column)) {
55
0
        return nullptr;
56
0
    }
57
58
141
    const auto* res = assert_cast<const ColumnConst*, TypeCheckOnRelease::DISABLE>(column);
59
60
141
    if (!is_column<Type>(&res->get_data_column())) {
61
0
        return nullptr;
62
0
    }
63
64
141
    return res;
65
141
}
_ZN5doris26check_and_get_column_constINS_12ColumnVectorILNS_13PrimitiveTypeE6EEEEEPKNS_11ColumnConstEPKNS_7IColumnE
Line
Count
Source
53
105
const ColumnConst* check_and_get_column_const(const IColumn* column) {
54
105
    if (!column || !is_column_const(*column)) {
55
0
        return nullptr;
56
0
    }
57
58
105
    const auto* res = assert_cast<const ColumnConst*, TypeCheckOnRelease::DISABLE>(column);
59
60
105
    if (!is_column<Type>(&res->get_data_column())) {
61
0
        return nullptr;
62
0
    }
63
64
105
    return res;
65
105
}
_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
7
const ColumnConst* check_and_get_column_const(const IColumn* column) {
54
7
    if (!column || !is_column_const(*column)) {
55
0
        return nullptr;
56
0
    }
57
58
7
    const auto* res = assert_cast<const ColumnConst*, TypeCheckOnRelease::DISABLE>(column);
59
60
7
    if (!is_column<Type>(&res->get_data_column())) {
61
0
        return nullptr;
62
0
    }
63
64
7
    return res;
65
7
}
Unexecuted instantiation: _ZN5doris26check_and_get_column_constINS_12ColumnVectorILNS_13PrimitiveTypeE11EEEEEPKNS_11ColumnConstEPKNS_7IColumnE
_ZN5doris26check_and_get_column_constINS_12ColumnVectorILNS_13PrimitiveTypeE25EEEEEPKNS_11ColumnConstEPKNS_7IColumnE
Line
Count
Source
53
17
const ColumnConst* check_and_get_column_const(const IColumn* column) {
54
17
    if (!column || !is_column_const(*column)) {
55
0
        return nullptr;
56
0
    }
57
58
17
    const auto* res = assert_cast<const ColumnConst*, TypeCheckOnRelease::DISABLE>(column);
59
60
17
    if (!is_column<Type>(&res->get_data_column())) {
61
0
        return nullptr;
62
0
    }
63
64
17
    return res;
65
17
}
_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
Unexecuted instantiation: _ZN5doris26check_and_get_column_constINS_12ColumnVectorILNS_13PrimitiveTypeE27EEEEEPKNS_11ColumnConstEPKNS_7IColumnE
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_9ColumnStrIjEEEEPKNS_11ColumnConstEPKNS_7IColumnE
Line
Count
Source
53
55
const ColumnConst* check_and_get_column_const(const IColumn* column) {
54
55
    if (!column || !is_column_const(*column)) {
55
55
        return nullptr;
56
55
    }
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
54
const ColumnConst* check_and_get_column_const(const IColumn* column) {
54
54
    if (!column || !is_column_const(*column)) {
55
49
        return nullptr;
56
49
    }
57
58
5
    const auto* res = assert_cast<const ColumnConst*, TypeCheckOnRelease::DISABLE>(column);
59
60
5
    if (!is_column<Type>(&res->get_data_column())) {
61
0
        return nullptr;
62
0
    }
63
64
5
    return res;
65
5
}
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
bool check_column_const(const IColumn* column) {
80
    return check_and_get_column_const<Type>(column);
81
}
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
114
Field to_field(const typename PrimitiveTypeTraits<T>::CppType& x) {
90
114
    return Field::create_field<T>(typename PrimitiveTypeTraits<T>::CppType(x));
91
114
}
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
114
Field to_field(const typename PrimitiveTypeTraits<T>::CppType& x) {
90
114
    return Field::create_field<T>(typename PrimitiveTypeTraits<T>::CppType(x));
91
114
}
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