Coverage Report

Created: 2026-04-16 17:24

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
be/src/storage/index/index_writer.cpp
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
18
#include "common/exception.h"
19
#include "storage/field.h"
20
#include "storage/index/ann/ann_index_writer.h"
21
#include "storage/index/inverted/inverted_index_writer.h"
22
23
namespace doris::segment_v2 {
24
25
30.0k
bool IndexColumnWriter::check_support_inverted_index(const TabletColumn& column) {
26
    // bellow types are not supported in inverted index for extracted columns
27
30.0k
    static std::set<FieldType> invalid_types = {FieldType::OLAP_FIELD_TYPE_JSONB};
28
30.0k
    if (invalid_types.contains(column.type())) {
29
0
        return false;
30
0
    }
31
30.0k
    if (column.is_variant_type()) {
32
398
        return false;
33
398
    }
34
29.7k
    if (column.is_array_type()) {
35
        // only support one level array
36
22
        const auto& subcolumn = column.get_sub_column(0);
37
22
        return !subcolumn.is_array_type() && check_support_inverted_index(subcolumn);
38
22
    }
39
29.6k
    return true;
40
29.7k
}
41
42
26.1k
bool IndexColumnWriter::check_support_ann_index(const TabletColumn& column) {
43
    // only array are supported in ann index
44
26.1k
    return column.is_array_type();
45
26.1k
}
46
47
// create index writer
48
Status IndexColumnWriter::create(const StorageField* field, std::unique_ptr<IndexColumnWriter>* res,
49
                                 IndexFileWriter* index_file_writer,
50
2.28k
                                 const TabletIndex* index_meta) {
51
2.28k
    const auto* typeinfo = field->type_info();
52
2.28k
    FieldType type = typeinfo->type();
53
2.28k
    std::string field_name;
54
2.28k
    auto storage_format = index_file_writer->get_storage_format();
55
2.28k
    if (storage_format == InvertedIndexStorageFormatPB::V1) {
56
19
        field_name = field->name();
57
2.26k
    } else {
58
2.26k
        if (field->is_extracted_column()) {
59
            // variant sub col
60
            // field_name format: parent_unique_id.sub_col_name
61
0
            field_name = std::to_string(field->parent_unique_id()) + "." + field->name();
62
2.26k
        } else {
63
2.26k
            field_name = std::to_string(field->unique_id());
64
2.26k
        }
65
2.26k
    }
66
67
2.28k
    if (index_meta->is_inverted_index()) {
68
2.28k
        bool single_field = true;
69
2.28k
        if (type == FieldType::OLAP_FIELD_TYPE_ARRAY) {
70
10
            const auto* array_typeinfo = dynamic_cast<const ArrayTypeInfo*>(typeinfo);
71
10
            DBUG_EXECUTE_IF("InvertedIndexColumnWriter::create_array_typeinfo_is_nullptr",
72
10
                            { array_typeinfo = nullptr; })
73
10
            if (array_typeinfo != nullptr) {
74
10
                typeinfo = array_typeinfo->item_type_info();
75
10
                type = typeinfo->type();
76
10
                single_field = false;
77
10
            } else {
78
0
                return Status::NotSupported("unsupported array type for inverted index: " +
79
0
                                            std::to_string(int(type)));
80
0
            }
81
10
        }
82
83
2.28k
        DBUG_EXECUTE_IF("InvertedIndexColumnWriter::create_unsupported_type_for_inverted_index",
84
2.28k
                        { type = FieldType::OLAP_FIELD_TYPE_JSONB; })
85
2.28k
        switch (type) {
86
0
#define M(TYPE)                                                                                 \
87
2.28k
    case TYPE:                                                                                  \
88
2.28k
        *res = std::make_unique<InvertedIndexColumnWriter<TYPE>>(field_name, index_file_writer, \
89
2.28k
                                                                 index_meta, single_field);     \
90
2.28k
        break;
91
1
            M(FieldType::OLAP_FIELD_TYPE_TINYINT)
92
1
            M(FieldType::OLAP_FIELD_TYPE_SMALLINT)
93
443
            M(FieldType::OLAP_FIELD_TYPE_INT)
94
0
            M(FieldType::OLAP_FIELD_TYPE_UNSIGNED_INT)
95
1
            M(FieldType::OLAP_FIELD_TYPE_BIGINT)
96
1
            M(FieldType::OLAP_FIELD_TYPE_LARGEINT)
97
0
            M(FieldType::OLAP_FIELD_TYPE_CHAR)
98
50
            M(FieldType::OLAP_FIELD_TYPE_VARCHAR)
99
1.77k
            M(FieldType::OLAP_FIELD_TYPE_STRING)
100
1
            M(FieldType::OLAP_FIELD_TYPE_DATE)
101
1
            M(FieldType::OLAP_FIELD_TYPE_DATETIME)
102
0
            M(FieldType::OLAP_FIELD_TYPE_DECIMAL)
103
1
            M(FieldType::OLAP_FIELD_TYPE_DATEV2)
104
1
            M(FieldType::OLAP_FIELD_TYPE_DATETIMEV2)
105
2
            M(FieldType::OLAP_FIELD_TYPE_TIMESTAMPTZ)
106
0
            M(FieldType::OLAP_FIELD_TYPE_DECIMAL32)
107
0
            M(FieldType::OLAP_FIELD_TYPE_DECIMAL64)
108
0
            M(FieldType::OLAP_FIELD_TYPE_DECIMAL128I)
109
0
            M(FieldType::OLAP_FIELD_TYPE_DECIMAL256)
110
1
            M(FieldType::OLAP_FIELD_TYPE_BOOL)
111
0
            M(FieldType::OLAP_FIELD_TYPE_IPV4)
112
0
            M(FieldType::OLAP_FIELD_TYPE_IPV6)
113
0
            M(FieldType::OLAP_FIELD_TYPE_FLOAT)
114
0
            M(FieldType::OLAP_FIELD_TYPE_DOUBLE)
115
0
#undef M
116
1
        default:
117
1
            return Status::NotSupported("unsupported type for inverted index: " +
118
1
                                        std::to_string(int(type)));
119
2.28k
        }
120
2.28k
        if (*res != nullptr) {
121
2.28k
            auto st = (*res)->init();
122
2.28k
            if (!st.ok()) {
123
0
                (*res)->close_on_error();
124
0
                return st;
125
0
            }
126
2.28k
        }
127
2.28k
    } else if (index_meta->is_ann_index()) {
128
2
        DCHECK(type == FieldType::OLAP_FIELD_TYPE_ARRAY);
129
2
        *res = std ::make_unique<AnnIndexColumnWriter>(index_file_writer, index_meta);
130
2
        if (*res != nullptr) {
131
2
            auto st = (*res)->init();
132
2
            if (!st.ok()) {
133
0
                (*res)->close_on_error();
134
0
                return st;
135
0
            }
136
2
        }
137
2
    }
138
139
2.28k
    return Status::OK();
140
2.28k
}
141
142
} // namespace doris::segment_v2