Coverage Report

Created: 2026-05-14 11:58

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
27.3M
bool IndexColumnWriter::check_support_inverted_index(const TabletColumn& column) {
26
    // bellow types are not supported in inverted index for extracted columns
27
27.3M
    static std::set<FieldType> invalid_types = {FieldType::OLAP_FIELD_TYPE_JSONB};
28
27.3M
    if (invalid_types.contains(column.type())) {
29
36.7k
        return false;
30
36.7k
    }
31
27.3M
    if (column.is_variant_type()) {
32
20.4k
        return false;
33
20.4k
    }
34
27.2M
    if (column.is_array_type()) {
35
        // only support one level array
36
117k
        const auto& subcolumn = column.get_sub_column(0);
37
117k
        return !subcolumn.is_array_type() && check_support_inverted_index(subcolumn);
38
117k
    }
39
27.1M
    return true;
40
27.2M
}
41
42
26.4M
bool IndexColumnWriter::check_support_ann_index(const TabletColumn& column) {
43
    // only array are supported in ann index
44
26.4M
    return column.is_array_type();
45
26.4M
}
46
47
// create index writer
48
Status IndexColumnWriter::create(const StorageField* field, std::unique_ptr<IndexColumnWriter>* res,
49
                                 IndexFileWriter* index_file_writer,
50
43.0k
                                 const TabletIndex* index_meta) {
51
43.0k
    FieldType type = field->type();
52
43.0k
    std::string field_name;
53
43.0k
    auto storage_format = index_file_writer->get_storage_format();
54
43.0k
    if (storage_format == InvertedIndexStorageFormatPB::V1) {
55
584
        field_name = field->name();
56
42.4k
    } else {
57
42.4k
        if (field->is_extracted_column()) {
58
            // variant sub col
59
            // field_name format: parent_unique_id.sub_col_name
60
9.91k
            field_name = std::to_string(field->parent_unique_id()) + "." + field->name();
61
32.5k
        } else {
62
32.5k
            field_name = std::to_string(field->unique_id());
63
32.5k
        }
64
42.4k
    }
65
66
43.0k
    if (index_meta->is_inverted_index()) {
67
43.0k
        bool single_field = true;
68
43.0k
        if (type == FieldType::OLAP_FIELD_TYPE_ARRAY) {
69
2.08k
            const auto& column = field->get_desc();
70
2.08k
            bool has_item_subcolumn = column.get_subtype_count() > 0;
71
2.08k
            DBUG_EXECUTE_IF("InvertedIndexColumnWriter::create_array_typeinfo_is_nullptr",
72
2.08k
                            { has_item_subcolumn = false; })
73
2.08k
            if (has_item_subcolumn) {
74
2.08k
                type = column.get_sub_column(0).type();
75
2.08k
                single_field = false;
76
2.08k
            } else {
77
0
                return Status::NotSupported("unsupported array type for inverted index: " +
78
0
                                            std::to_string(int(type)));
79
0
            }
80
2.08k
        }
81
82
43.0k
        DBUG_EXECUTE_IF("InvertedIndexColumnWriter::create_unsupported_type_for_inverted_index",
83
43.0k
                        { type = FieldType::OLAP_FIELD_TYPE_JSONB; })
84
43.0k
        switch (type) {
85
0
#define M(TYPE)                                                                                 \
86
43.0k
    case TYPE:                                                                                  \
87
43.0k
        *res = std::make_unique<InvertedIndexColumnWriter<TYPE>>(field_name, index_file_writer, \
88
43.0k
                                                                 index_meta, single_field);     \
89
43.0k
        break;
90
317
            M(FieldType::OLAP_FIELD_TYPE_TINYINT)
91
288
            M(FieldType::OLAP_FIELD_TYPE_SMALLINT)
92
6.28k
            M(FieldType::OLAP_FIELD_TYPE_INT)
93
0
            M(FieldType::OLAP_FIELD_TYPE_UNSIGNED_INT)
94
4.36k
            M(FieldType::OLAP_FIELD_TYPE_BIGINT)
95
429
            M(FieldType::OLAP_FIELD_TYPE_LARGEINT)
96
645
            M(FieldType::OLAP_FIELD_TYPE_CHAR)
97
6.08k
            M(FieldType::OLAP_FIELD_TYPE_VARCHAR)
98
11.9k
            M(FieldType::OLAP_FIELD_TYPE_STRING)
99
28
            M(FieldType::OLAP_FIELD_TYPE_DATE)
100
28
            M(FieldType::OLAP_FIELD_TYPE_DATETIME)
101
1
            M(FieldType::OLAP_FIELD_TYPE_DECIMAL)
102
4.28k
            M(FieldType::OLAP_FIELD_TYPE_DATEV2)
103
2.36k
            M(FieldType::OLAP_FIELD_TYPE_DATETIMEV2)
104
4
            M(FieldType::OLAP_FIELD_TYPE_TIMESTAMPTZ)
105
1.33k
            M(FieldType::OLAP_FIELD_TYPE_DECIMAL32)
106
584
            M(FieldType::OLAP_FIELD_TYPE_DECIMAL64)
107
442
            M(FieldType::OLAP_FIELD_TYPE_DECIMAL128I)
108
149
            M(FieldType::OLAP_FIELD_TYPE_DECIMAL256)
109
3.23k
            M(FieldType::OLAP_FIELD_TYPE_BOOL)
110
102
            M(FieldType::OLAP_FIELD_TYPE_IPV4)
111
116
            M(FieldType::OLAP_FIELD_TYPE_IPV6)
112
1
            M(FieldType::OLAP_FIELD_TYPE_FLOAT)
113
27
            M(FieldType::OLAP_FIELD_TYPE_DOUBLE)
114
0
#undef M
115
1
        default:
116
1
            return Status::NotSupported("unsupported type for inverted index: " +
117
1
                                        std::to_string(int(type)));
118
43.0k
        }
119
43.0k
        if (*res != nullptr) {
120
43.0k
            auto st = (*res)->init();
121
43.0k
            if (!st.ok()) {
122
0
                (*res)->close_on_error();
123
0
                return st;
124
0
            }
125
43.0k
        }
126
43.0k
    } else if (index_meta->is_ann_index()) {
127
2
        DCHECK(type == FieldType::OLAP_FIELD_TYPE_ARRAY);
128
2
        *res = std ::make_unique<AnnIndexColumnWriter>(index_file_writer, index_meta);
129
2
        if (*res != nullptr) {
130
2
            auto st = (*res)->init();
131
2
            if (!st.ok()) {
132
0
                (*res)->close_on_error();
133
0
                return st;
134
0
            }
135
2
        }
136
2
    }
137
138
43.0k
    return Status::OK();
139
43.0k
}
140
141
} // namespace doris::segment_v2