Coverage Report

Created: 2026-06-23 10:29

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
be/src/storage/segment/column_reader.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 "storage/segment/column_reader.h"
19
20
#include <assert.h>
21
#include <gen_cpp/Descriptors_types.h>
22
#include <gen_cpp/segment_v2.pb.h>
23
#include <glog/logging.h>
24
25
#include <algorithm>
26
#include <memory>
27
#include <ostream>
28
#include <set>
29
#include <utility>
30
31
#include "common/compiler_util.h" // IWYU pragma: keep
32
#include "common/status.h"
33
#include "core/assert_cast.h"
34
#include "core/binary_cast.hpp"
35
#include "core/column/column.h"
36
#include "core/column/column_array.h"
37
#include "core/column/column_map.h"
38
#include "core/column/column_nullable.h"
39
#include "core/column/column_struct.h"
40
#include "core/column/column_vector.h"
41
#include "core/data_type/data_type_agg_state.h"
42
#include "core/data_type/data_type_factory.hpp"
43
#include "core/data_type/data_type_nullable.h"
44
#include "core/data_type/define_primitive_type.h"
45
#include "core/decimal12.h"
46
#include "core/string_ref.h"
47
#include "core/types.h"
48
#include "core/value/decimalv2_value.h"
49
#include "core/value/vdatetime_value.h" //for VecDateTime
50
#include "io/fs/file_reader.h"
51
#include "storage/index/ann/ann_index_reader.h"
52
#include "storage/index/bloom_filter/bloom_filter.h"
53
#include "storage/index/bloom_filter/bloom_filter_index_reader.h"
54
#include "storage/index/index_file_reader.h"
55
#include "storage/index/index_reader.h"
56
#include "storage/index/inverted/analyzer/analyzer.h"
57
#include "storage/index/inverted/inverted_index_reader.h"
58
#include "storage/index/zone_map/zone_map_index.h"
59
#include "storage/iterators.h"
60
#include "storage/olap_common.h"
61
#include "storage/predicate/block_column_predicate.h"
62
#include "storage/predicate/column_predicate.h"
63
#include "storage/segment/binary_dict_page.h" // for BinaryDictPageDecoder
64
#include "storage/segment/binary_plain_page.h"
65
#include "storage/segment/column_meta_accessor.h"
66
#include "storage/segment/encoding_info.h" // for EncodingInfo
67
#include "storage/segment/page_decoder.h"
68
#include "storage/segment/page_handle.h" // for PageHandle
69
#include "storage/segment/page_io.h"
70
#include "storage/segment/page_pointer.h" // for PagePointer
71
#include "storage/segment/row_ranges.h"
72
#include "storage/segment/segment.h"
73
#include "storage/segment/segment_prefetcher.h"
74
#include "storage/segment/variant/variant_column_reader.h"
75
#include "storage/tablet/tablet_schema.h"
76
#include "storage/types.h" // for TypeInfo
77
#include "util/bitmap.h"
78
#include "util/block_compression.h"
79
#include "util/concurrency_stats.h"
80
#include "util/defer_op.h"
81
#include "util/rle_encoding.h" // for RleDecoder
82
#include "util/slice.h"
83
84
namespace doris::segment_v2 {
85
#include "storage/segment/column_reader.h"
86
87
0
inline bool read_as_string(PrimitiveType type) {
88
0
    return type == PrimitiveType::TYPE_STRING || type == PrimitiveType::INVALID_TYPE ||
89
0
           type == PrimitiveType::TYPE_BITMAP || type == PrimitiveType::TYPE_FIXED_LENGTH_OBJECT;
90
0
}
91
92
Status ColumnReader::create_array(const ColumnReaderOptions& opts, const ColumnMetaPB& meta,
93
                                  const io::FileReaderSPtr& file_reader,
94
36
                                  std::shared_ptr<ColumnReader>* reader) {
95
36
    DCHECK(meta.children_columns_size() == 2 || meta.children_columns_size() == 3);
96
97
36
    std::shared_ptr<ColumnReader> item_reader;
98
36
    RETURN_IF_ERROR(ColumnReader::create(opts, meta.children_columns(0),
99
36
                                         meta.children_columns(0).num_rows(), file_reader,
100
36
                                         &item_reader));
101
102
36
    std::shared_ptr<ColumnReader> offset_reader;
103
36
    RETURN_IF_ERROR(ColumnReader::create(opts, meta.children_columns(1),
104
36
                                         meta.children_columns(1).num_rows(), file_reader,
105
36
                                         &offset_reader));
106
107
36
    std::shared_ptr<ColumnReader> null_reader;
108
36
    if (meta.is_nullable()) {
109
34
        RETURN_IF_ERROR(ColumnReader::create(opts, meta.children_columns(2),
110
34
                                             meta.children_columns(2).num_rows(), file_reader,
111
34
                                             &null_reader));
112
34
    }
113
114
    // The num rows of the array reader equals to the num rows of the length reader.
115
36
    uint64_t array_num_rows = meta.children_columns(1).num_rows();
116
36
    std::shared_ptr<ColumnReader> array_reader(
117
36
            new ColumnReader(opts, meta, array_num_rows, file_reader));
118
    //  array reader do not need to init
119
36
    array_reader->_sub_readers.resize(meta.children_columns_size());
120
36
    array_reader->_sub_readers[0] = std::move(item_reader);
121
36
    array_reader->_sub_readers[1] = std::move(offset_reader);
122
36
    if (meta.is_nullable()) {
123
34
        array_reader->_sub_readers[2] = std::move(null_reader);
124
34
    }
125
36
    array_reader->_meta_type = FieldType::OLAP_FIELD_TYPE_ARRAY;
126
36
    *reader = std::move(array_reader);
127
36
    return Status::OK();
128
36
}
129
130
Status ColumnReader::create_map(const ColumnReaderOptions& opts, const ColumnMetaPB& meta,
131
                                const io::FileReaderSPtr& file_reader,
132
792
                                std::shared_ptr<ColumnReader>* reader) {
133
    // map reader now has 3 sub readers for key, value, offsets(scalar), null(scala)
134
792
    DCHECK(meta.children_columns_size() == 3 || meta.children_columns_size() == 4);
135
792
    std::shared_ptr<ColumnReader> key_reader;
136
792
    RETURN_IF_ERROR(ColumnReader::create(opts, meta.children_columns(0),
137
792
                                         meta.children_columns(0).num_rows(), file_reader,
138
792
                                         &key_reader));
139
792
    std::shared_ptr<ColumnReader> val_reader;
140
792
    RETURN_IF_ERROR(ColumnReader::create(opts, meta.children_columns(1),
141
792
                                         meta.children_columns(1).num_rows(), file_reader,
142
792
                                         &val_reader));
143
792
    std::shared_ptr<ColumnReader> offset_reader;
144
792
    RETURN_IF_ERROR(ColumnReader::create(opts, meta.children_columns(2),
145
792
                                         meta.children_columns(2).num_rows(), file_reader,
146
792
                                         &offset_reader));
147
792
    std::shared_ptr<ColumnReader> null_reader;
148
792
    if (meta.is_nullable()) {
149
0
        RETURN_IF_ERROR(ColumnReader::create(opts, meta.children_columns(3),
150
0
                                             meta.children_columns(3).num_rows(), file_reader,
151
0
                                             &null_reader));
152
0
    }
153
154
    // The num rows of the map reader equals to the num rows of the length reader.
155
792
    uint64_t map_num_rows = meta.children_columns(2).num_rows();
156
792
    std::shared_ptr<ColumnReader> map_reader(
157
792
            new ColumnReader(opts, meta, map_num_rows, file_reader));
158
792
    map_reader->_sub_readers.resize(meta.children_columns_size());
159
160
792
    map_reader->_sub_readers[0] = std::move(key_reader);
161
792
    map_reader->_sub_readers[1] = std::move(val_reader);
162
792
    map_reader->_sub_readers[2] = std::move(offset_reader);
163
792
    if (meta.is_nullable()) {
164
0
        map_reader->_sub_readers[3] = std::move(null_reader);
165
0
    }
166
792
    map_reader->_meta_type = FieldType::OLAP_FIELD_TYPE_MAP;
167
792
    *reader = std::move(map_reader);
168
792
    return Status::OK();
169
792
}
170
171
Status ColumnReader::create_struct(const ColumnReaderOptions& opts, const ColumnMetaPB& meta,
172
                                   uint64_t num_rows, const io::FileReaderSPtr& file_reader,
173
0
                                   std::shared_ptr<ColumnReader>* reader) {
174
    // not support empty struct
175
0
    DCHECK(meta.children_columns_size() >= 1);
176
    // create struct column reader
177
0
    std::shared_ptr<ColumnReader> struct_reader(
178
0
            new ColumnReader(opts, meta, num_rows, file_reader));
179
0
    struct_reader->_sub_readers.reserve(meta.children_columns_size());
180
    // now we support struct column can add the children columns according to the schema-change behavior
181
0
    for (int i = 0; i < meta.children_columns_size(); i++) {
182
0
        std::shared_ptr<ColumnReader> sub_reader;
183
0
        RETURN_IF_ERROR(ColumnReader::create(opts, meta.children_columns(i),
184
0
                                             meta.children_columns(i).num_rows(), file_reader,
185
0
                                             &sub_reader));
186
0
        struct_reader->_sub_readers.push_back(std::move(sub_reader));
187
0
    }
188
0
    struct_reader->_meta_type = FieldType::OLAP_FIELD_TYPE_STRUCT;
189
0
    *reader = std::move(struct_reader);
190
0
    return Status::OK();
191
0
}
192
193
Status ColumnReader::create_agg_state(const ColumnReaderOptions& opts, const ColumnMetaPB& meta,
194
                                      uint64_t num_rows, const io::FileReaderSPtr& file_reader,
195
0
                                      std::shared_ptr<ColumnReader>* reader) {
196
0
    if (!meta.has_function_name()) { // meet old version ColumnMetaPB
197
0
        std::shared_ptr<ColumnReader> reader_local(
198
0
                new ColumnReader(opts, meta, num_rows, file_reader));
199
0
        RETURN_IF_ERROR(reader_local->init(&meta));
200
0
        *reader = std::move(reader_local);
201
0
        return Status::OK();
202
0
    }
203
204
0
    auto data_type = DataTypeFactory::instance().create_data_type(meta);
205
0
    const auto* agg_state_type = assert_cast<const DataTypeAggState*>(data_type.get());
206
0
    agg_state_type->check_function_compatibility(opts.be_exec_version);
207
0
    auto type = agg_state_type->get_serialized_type()->get_primitive_type();
208
209
0
    if (read_as_string(type)) {
210
0
        std::shared_ptr<ColumnReader> reader_local(
211
0
                new ColumnReader(opts, meta, num_rows, file_reader));
212
0
        RETURN_IF_ERROR(reader_local->init(&meta));
213
0
        *reader = std::move(reader_local);
214
0
        return Status::OK();
215
0
    } else if (type == PrimitiveType::TYPE_MAP) {
216
0
        return create_map(opts, meta, file_reader, reader);
217
0
    } else if (type == PrimitiveType::TYPE_ARRAY) {
218
0
        return create_array(opts, meta, file_reader, reader);
219
0
    } else if (type == PrimitiveType::TYPE_STRUCT) {
220
0
        return create_struct(opts, meta, num_rows, file_reader, reader);
221
0
    }
222
223
0
    return Status::InternalError("Not supported type: {}, serialized type: {}",
224
0
                                 agg_state_type->get_name(), int(type));
225
0
}
226
227
1.50k
bool ColumnReader::is_compaction_reader_type(ReaderType type) {
228
1.50k
    return type == ReaderType::READER_BASE_COMPACTION ||
229
1.50k
           type == ReaderType::READER_CUMULATIVE_COMPACTION ||
230
1.50k
           type == ReaderType::READER_COLD_DATA_COMPACTION ||
231
1.50k
           type == ReaderType::READER_SEGMENT_COMPACTION ||
232
1.50k
           type == ReaderType::READER_FULL_COMPACTION;
233
1.50k
}
234
235
Status ColumnReader::create(const ColumnReaderOptions& opts, const ColumnMetaPB& meta,
236
                            uint64_t num_rows, const io::FileReaderSPtr& file_reader,
237
11.9k
                            std::shared_ptr<ColumnReader>* reader) {
238
11.9k
    if (is_scalar_type((FieldType)meta.type())) {
239
10.3k
        std::shared_ptr<ColumnReader> reader_local(
240
10.3k
                new ColumnReader(opts, meta, num_rows, file_reader));
241
10.3k
        RETURN_IF_ERROR(reader_local->init(&meta));
242
10.3k
        *reader = std::move(reader_local);
243
10.3k
        return Status::OK();
244
10.3k
    } else {
245
1.57k
        auto type = (FieldType)meta.type();
246
1.57k
        switch (type) {
247
0
        case FieldType::OLAP_FIELD_TYPE_AGG_STATE: {
248
0
            return create_agg_state(opts, meta, num_rows, file_reader, reader);
249
0
        }
250
0
        case FieldType::OLAP_FIELD_TYPE_STRUCT: {
251
0
            return create_struct(opts, meta, num_rows, file_reader, reader);
252
0
        }
253
36
        case FieldType::OLAP_FIELD_TYPE_ARRAY: {
254
36
            return create_array(opts, meta, file_reader, reader);
255
0
        }
256
792
        case FieldType::OLAP_FIELD_TYPE_MAP: {
257
792
            return create_map(opts, meta, file_reader, reader);
258
0
        }
259
751
        case FieldType::OLAP_FIELD_TYPE_VARIANT: {
260
            // Read variant only root data using a single ColumnReader
261
751
            std::shared_ptr<ColumnReader> reader_local(
262
751
                    new ColumnReader(opts, meta, num_rows, file_reader));
263
751
            RETURN_IF_ERROR(reader_local->init(&meta));
264
751
            *reader = std::move(reader_local);
265
751
            return Status::OK();
266
751
        }
267
0
        default:
268
0
            return Status::NotSupported("unsupported type for ColumnReader: {}",
269
0
                                        std::to_string(int(type)));
270
1.57k
        }
271
1.57k
    }
272
11.9k
}
273
274
788
ColumnReader::ColumnReader() = default;
275
276
ColumnReader::ColumnReader(const ColumnReaderOptions& opts, const ColumnMetaPB& meta,
277
                           uint64_t num_rows, io::FileReaderSPtr file_reader)
278
11.9k
        : _use_index_page_cache(!config::disable_storage_page_cache),
279
11.9k
          _opts(opts),
280
11.9k
          _num_rows(num_rows),
281
11.9k
          _file_reader(std::move(file_reader)),
282
11.9k
          _dict_encoding_type(UNKNOWN_DICT_ENCODING) {
283
11.9k
    _meta_length = meta.length();
284
11.9k
    _meta_type = (FieldType)meta.type();
285
11.9k
    if (_meta_type == FieldType::OLAP_FIELD_TYPE_ARRAY) {
286
36
        _meta_children_column_type = (FieldType)meta.children_columns(0).type();
287
36
    }
288
11.9k
    _data_type = DataTypeFactory::instance().create_data_type(meta);
289
11.9k
    _meta_is_nullable = meta.is_nullable();
290
11.9k
    _meta_dict_page = meta.dict_page();
291
11.9k
    _meta_compression = meta.compression();
292
11.9k
}
293
294
12.7k
ColumnReader::~ColumnReader() = default;
295
296
11.3k
int64_t ColumnReader::get_metadata_size() const {
297
11.3k
    return sizeof(ColumnReader) + (_segment_zone_map ? _segment_zone_map->ByteSizeLong() : 0);
298
11.3k
}
299
300
#ifdef BE_TEST
301
/// This function is only used in UT to verify the correctness of data read from zone map
302
/// See UT case 'SegCompactionMoWTest.SegCompactionInterleaveWithBig_ooooOOoOooooooooO'
303
/// be/test/olap/segcompaction_mow_test.cpp
304
20.5k
void ColumnReader::check_data_by_zone_map_for_test(const MutableColumnPtr& dst) const {
305
20.5k
    if (!_segment_zone_map) {
306
2.14k
        return;
307
2.14k
    }
308
309
18.3k
    const auto rows = dst->size();
310
18.3k
    if (rows == 0) {
311
0
        return;
312
0
    }
313
314
18.3k
    FieldType type = _type;
315
316
18.3k
    if (type != FieldType::OLAP_FIELD_TYPE_INT) {
317
2.94k
        return;
318
2.94k
    }
319
320
15.4k
    auto* non_nullable_column =
321
15.4k
            is_column_nullable(*dst)
322
15.4k
                    ? assert_cast<ColumnNullable*>(dst.get())->get_nested_column_ptr().get()
323
15.4k
                    : dst.get();
324
325
    /// Only verify when the destination column carries Field-accessible TYPE_INT data.
326
15.4k
    if (check_and_get_column<ColumnVector<TYPE_INT>>(non_nullable_column) == nullptr) {
327
0
        return;
328
0
    }
329
330
15.4k
    ZoneMap zone_map;
331
15.4k
    THROW_IF_ERROR(ZoneMap::from_proto(*_segment_zone_map, _data_type, zone_map));
332
333
15.4k
    if (zone_map.has_null) {
334
10
        return;
335
10
    }
336
337
22.1M
    for (size_t i = 0; i != rows; ++i) {
338
22.1M
        Field field;
339
22.1M
        dst->get(i, field);
340
22.1M
        DCHECK(!field.is_null());
341
22.1M
        const auto v = field.get<TYPE_INT>();
342
22.1M
        DCHECK_GE(v, zone_map.min_value.get<TYPE_INT>());
343
22.1M
        DCHECK_LE(v, zone_map.max_value.get<TYPE_INT>());
344
22.1M
    }
345
15.4k
}
346
#endif
347
348
11.1k
Status ColumnReader::init(const ColumnMetaPB* meta) {
349
11.1k
    _type = (FieldType)meta->type();
350
351
11.1k
    if (meta->has_be_exec_version()) {
352
7.98k
        _be_exec_version = meta->be_exec_version();
353
7.98k
    }
354
355
11.1k
    if (_type == FieldType::OLAP_FIELD_TYPE_NONE || _type == FieldType::OLAP_FIELD_TYPE_UNKNOWN) {
356
0
        return Status::NotSupported("unsupported typeinfo, type={}", meta->type());
357
0
    }
358
11.1k
    RETURN_IF_ERROR(EncodingInfo::get(_type, meta->encoding(), &_encoding_info));
359
360
29.2k
    for (int i = 0; i < meta->indexes_size(); i++) {
361
18.1k
        const auto& index_meta = meta->indexes(i);
362
18.1k
        switch (index_meta.type()) {
363
0
        case BITMAP_INDEX:
364
0
            break;
365
10.5k
        case ORDINAL_INDEX:
366
10.5k
            _ordinal_index.reset(
367
10.5k
                    new OrdinalIndexReader(_file_reader, _num_rows, index_meta.ordinal_index()));
368
10.5k
            break;
369
7.56k
        case ZONE_MAP_INDEX:
370
7.56k
            _segment_zone_map =
371
7.56k
                    std::make_unique<ZoneMapPB>(index_meta.zone_map_index().segment_zone_map());
372
7.56k
            _zone_map_index.reset(new ZoneMapIndexReader(
373
7.56k
                    _file_reader, index_meta.zone_map_index().page_zone_maps()));
374
7.56k
            break;
375
7
        case BLOOM_FILTER_INDEX:
376
7
            _bloom_filter_index.reset(
377
7
                    new BloomFilterIndexReader(_file_reader, index_meta.bloom_filter_index()));
378
7
            break;
379
0
        case NESTED_OFFSETS_INDEX:
380
0
            break;
381
0
        default:
382
0
            return Status::Corruption("Bad file {}: invalid column index type {}",
383
0
                                      _file_reader->path().native(), index_meta.type());
384
18.1k
        }
385
18.1k
    }
386
11.1k
    update_metadata_size();
387
388
    // ArrayColumnWriter writes a single empty array and flushes. In this scenario,
389
    // the item writer doesn't write any data and the corresponding ordinal index is empty.
390
11.1k
    if (_ordinal_index == nullptr && !is_empty()) {
391
0
        return Status::Corruption("Bad file {}: missing ordinal index for column {}",
392
0
                                  _file_reader->path().native(), meta->column_id());
393
0
    }
394
395
11.1k
    return Status::OK();
396
11.1k
}
397
398
Status ColumnReader::new_index_iterator(const std::shared_ptr<IndexFileReader>& index_file_reader,
399
                                        const TabletIndex* index_meta, const std::string& rowset_id,
400
                                        uint32_t segment_id, size_t rows_of_segment,
401
2.67k
                                        std::unique_ptr<IndexIterator>* iterator) {
402
2.67k
    RETURN_IF_ERROR(
403
2.67k
            _load_index(index_file_reader, index_meta, rowset_id, segment_id, rows_of_segment));
404
2.67k
    {
405
2.67k
        std::shared_lock<std::shared_mutex> rlock(_load_index_lock);
406
2.67k
        auto iter = _index_readers.find(index_meta->index_id());
407
2.67k
        if (iter != _index_readers.end()) {
408
2.67k
            if (iter->second != nullptr) {
409
2.67k
                RETURN_IF_ERROR(iter->second->new_iterator(iterator));
410
2.67k
            }
411
2.67k
        }
412
2.67k
    }
413
2.67k
    return Status::OK();
414
2.67k
}
415
416
Status ColumnReader::read_page(const ColumnIteratorOptions& iter_opts, const PagePointer& pp,
417
                               PageHandle* handle, Slice* page_body, PageFooterPB* footer,
418
13.9k
                               BlockCompressionCodec* codec) const {
419
13.9k
    SCOPED_CONCURRENCY_COUNT(ConcurrencyStatsManager::instance().column_reader_read_page);
420
13.9k
    iter_opts.sanity_check();
421
13.9k
    PageReadOptions opts(iter_opts.io_ctx);
422
13.9k
    opts.verify_checksum = _opts.verify_checksum;
423
13.9k
    opts.use_page_cache = iter_opts.use_page_cache;
424
13.9k
    opts.kept_in_memory = _opts.kept_in_memory;
425
13.9k
    opts.type = iter_opts.type;
426
13.9k
    opts.file_reader = iter_opts.file_reader;
427
13.9k
    opts.page_pointer = pp;
428
13.9k
    opts.codec = codec;
429
13.9k
    opts.stats = iter_opts.stats;
430
13.9k
    opts.encoding_info = _encoding_info;
431
432
13.9k
    return PageIO::read_and_decompress_page(opts, handle, page_body, footer);
433
13.9k
}
434
435
Status ColumnReader::get_row_ranges_by_zone_map(
436
        const AndBlockColumnPredicate* col_predicates,
437
        const std::vector<std::shared_ptr<const ColumnPredicate>>* delete_predicates,
438
63
        RowRanges* row_ranges, const ColumnIteratorOptions& iter_opts) {
439
63
    std::vector<uint32_t> page_indexes;
440
63
    RETURN_IF_ERROR(
441
63
            _get_filtered_pages(col_predicates, delete_predicates, &page_indexes, iter_opts));
442
63
    RETURN_IF_ERROR(_calculate_row_ranges(page_indexes, row_ranges, iter_opts));
443
63
    return Status::OK();
444
63
}
445
446
0
Status ColumnReader::next_batch_of_zone_map(size_t* n, MutableColumnPtr& dst) const {
447
0
    if (_segment_zone_map == nullptr) {
448
0
        return Status::InternalError("segment zonemap not exist");
449
0
    }
450
    // TODO: this work to get min/max value seems should only do once
451
0
    ZoneMap zone_map;
452
0
    RETURN_IF_ERROR(ZoneMap::from_proto(*_segment_zone_map, _data_type, zone_map));
453
454
0
    dst->reserve(*n);
455
0
    if (!zone_map.has_not_null) {
456
0
        assert_cast<ColumnNullable&>(*dst).insert_many_defaults(*n);
457
0
        return Status::OK();
458
0
    }
459
0
    dst->insert(zone_map.max_value);
460
0
    for (int i = 1; i < *n; ++i) {
461
0
        dst->insert(zone_map.min_value);
462
0
    }
463
0
    return Status::OK();
464
0
}
465
466
Status ColumnReader::match_condition(const AndBlockColumnPredicate* col_predicates,
467
69
                                     bool* matched) const {
468
69
    *matched = true;
469
69
    if (_zone_map_index == nullptr) {
470
0
        return Status::OK();
471
0
    }
472
69
    ZoneMap zone_map;
473
69
    RETURN_IF_ERROR(ZoneMap::from_proto(*_segment_zone_map, _data_type, zone_map));
474
475
69
    *matched = _zone_map_match_condition(zone_map, col_predicates);
476
69
    return Status::OK();
477
69
}
478
479
Status ColumnReader::prune_predicates_by_zone_map(
480
        std::vector<std::shared_ptr<ColumnPredicate>>& predicates, const int column_id,
481
65
        bool* pruned) const {
482
65
    *pruned = false;
483
65
    if (_zone_map_index == nullptr) {
484
45
        return Status::OK();
485
45
    }
486
487
20
    ZoneMap zone_map;
488
20
    RETURN_IF_ERROR(ZoneMap::from_proto(*_segment_zone_map, _data_type, zone_map));
489
20
    if (zone_map.pass_all) {
490
0
        return Status::OK();
491
0
    }
492
493
40
    for (auto it = predicates.begin(); it != predicates.end();) {
494
20
        auto predicate = *it;
495
20
        if (predicate->column_id() == column_id && predicate->is_always_true(zone_map)) {
496
0
            *pruned = true;
497
0
            it = predicates.erase(it);
498
20
        } else {
499
20
            ++it;
500
20
        }
501
20
    }
502
20
    return Status::OK();
503
20
}
504
505
bool ColumnReader::_zone_map_match_condition(const ZoneMap& zone_map,
506
76
                                             const AndBlockColumnPredicate* col_predicates) const {
507
76
    if (zone_map.pass_all) {
508
0
        return true;
509
0
    }
510
511
76
    return col_predicates->evaluate_and(zone_map);
512
76
}
513
514
Status ColumnReader::_get_filtered_pages(
515
        const AndBlockColumnPredicate* col_predicates,
516
        const std::vector<std::shared_ptr<const ColumnPredicate>>* delete_predicates,
517
63
        std::vector<uint32_t>* page_indexes, const ColumnIteratorOptions& iter_opts) {
518
63
    RETURN_IF_ERROR(_load_zone_map_index(_use_index_page_cache, _opts.kept_in_memory, iter_opts));
519
520
63
    const std::vector<ZoneMapPB>& zone_maps = _zone_map_index->page_zone_maps();
521
63
    size_t page_size = _zone_map_index->num_pages();
522
63
    VLOG_DEBUG << fmt::format("page zonemap start rows={} pages={} type={}", _num_rows, page_size,
523
0
                              _data_type ? _data_type->get_name() : "null");
524
126
    for (size_t i = 0; i < page_size; ++i) {
525
63
        if (zone_maps[i].pass_all()) {
526
56
            page_indexes->push_back(cast_set<uint32_t>(i));
527
56
            VLOG_DEBUG << fmt::format("page zonemap page={} pass_all=true keep=true", i);
528
56
        } else {
529
7
            segment_v2::ZoneMap zone_map;
530
7
            RETURN_IF_ERROR(ZoneMap::from_proto(zone_maps[i], _data_type, zone_map));
531
7
            const bool matched = _zone_map_match_condition(zone_map, col_predicates);
532
7
            VLOG_DEBUG << fmt::format(
533
0
                    "page zonemap page={} pass_all=false has_null={} has_not_null={} "
534
0
                    "min={} max={} predicate_match={}",
535
0
                    i, zone_map.has_null, zone_map.has_not_null,
536
0
                    zone_map.min_value.to_debug_string(0), zone_map.max_value.to_debug_string(0),
537
0
                    matched);
538
7
            if (matched) {
539
7
                bool should_read = true;
540
7
                if (delete_predicates != nullptr) {
541
0
                    for (auto del_pred : *delete_predicates) {
542
                        // TODO: Both `min_value` and `max_value` should be 0 or neither should be 0.
543
                        //  So nullable only need to judge once.
544
0
                        if (del_pred->evaluate_del(zone_map)) {
545
0
                            should_read = false;
546
0
                            break;
547
0
                        }
548
0
                    }
549
0
                }
550
7
                if (should_read) {
551
7
                    page_indexes->push_back(cast_set<uint32_t>(i));
552
7
                }
553
7
                VLOG_DEBUG << fmt::format("page zonemap page={} keep={}", i, should_read);
554
7
            }
555
7
        }
556
63
    }
557
63
    VLOG(1) << "total-pages: " << page_size << " not-filtered-pages: " << page_indexes->size()
558
63
            << " filtered-percent:"
559
63
            << 1.0 - (static_cast<double>(page_indexes->size()) /
560
63
                      (static_cast<double>(page_size) * 1.0));
561
63
    return Status::OK();
562
63
}
563
564
Status ColumnReader::_calculate_row_ranges(const std::vector<uint32_t>& page_indexes,
565
                                           RowRanges* row_ranges,
566
63
                                           const ColumnIteratorOptions& iter_opts) {
567
63
    row_ranges->clear();
568
63
    RETURN_IF_ERROR(_load_ordinal_index(_use_index_page_cache, _opts.kept_in_memory, iter_opts));
569
63
    for (auto i : page_indexes) {
570
63
        ordinal_t page_first_id = _ordinal_index->get_first_ordinal(i);
571
63
        ordinal_t page_last_id = _ordinal_index->get_last_ordinal(i);
572
63
        VLOG_DEBUG << fmt::format("page zonemap ranges page={} first={} last={}", i, page_first_id,
573
0
                                  page_last_id);
574
63
        RowRanges page_row_ranges(RowRanges::create_single(page_first_id, page_last_id + 1));
575
63
        RowRanges::ranges_union(*row_ranges, page_row_ranges, row_ranges);
576
63
    }
577
63
    VLOG_DEBUG << fmt::format("page zonemap ranges result count={} ranges={}", row_ranges->count(),
578
0
                              row_ranges->to_string());
579
63
    return Status::OK();
580
63
}
581
582
Status ColumnReader::get_row_ranges_by_bloom_filter(const AndBlockColumnPredicate* col_predicates,
583
                                                    RowRanges* row_ranges,
584
3
                                                    const ColumnIteratorOptions& iter_opts) {
585
3
    RETURN_IF_ERROR(_load_ordinal_index(_use_index_page_cache, _opts.kept_in_memory, iter_opts));
586
3
    RETURN_IF_ERROR(
587
3
            _load_bloom_filter_index(_use_index_page_cache, _opts.kept_in_memory, iter_opts));
588
3
    RowRanges bf_row_ranges;
589
3
    std::unique_ptr<BloomFilterIndexIterator> bf_iter;
590
3
    RETURN_IF_ERROR(_bloom_filter_index->new_iterator(&bf_iter, iter_opts.stats));
591
3
    size_t range_size = row_ranges->range_size();
592
    // get covered page ids
593
3
    std::set<uint32_t> page_ids;
594
6
    for (int i = 0; i < range_size; ++i) {
595
3
        int64_t from = row_ranges->get_range_from(i);
596
3
        int64_t idx = from;
597
3
        int64_t to = row_ranges->get_range_to(i);
598
3
        auto iter = _ordinal_index->seek_at_or_before(from);
599
6
        while (idx < to && iter.valid()) {
600
3
            page_ids.insert(iter.page_index());
601
3
            idx = iter.last_ordinal() + 1;
602
3
            iter.next();
603
3
        }
604
3
    }
605
3
    for (auto& pid : page_ids) {
606
3
        std::unique_ptr<BloomFilter> bf;
607
3
        RETURN_IF_ERROR(bf_iter->read_bloom_filter(pid, &bf));
608
3
        if (col_predicates->evaluate_and(bf.get())) {
609
0
            bf_row_ranges.add(RowRange(_ordinal_index->get_first_ordinal(pid),
610
0
                                       _ordinal_index->get_last_ordinal(pid) + 1));
611
0
        }
612
3
    }
613
3
    RowRanges::ranges_intersection(*row_ranges, bf_row_ranges, row_ranges);
614
3
    return Status::OK();
615
3
}
616
617
Status ColumnReader::_load_ordinal_index(bool use_page_cache, bool kept_in_memory,
618
9.13k
                                         const ColumnIteratorOptions& iter_opts) {
619
9.13k
    if (!_ordinal_index) {
620
0
        return Status::InternalError("ordinal_index not inited");
621
0
    }
622
9.13k
    return _ordinal_index->load(use_page_cache, kept_in_memory, iter_opts.stats);
623
9.13k
}
624
625
Status ColumnReader::_load_zone_map_index(bool use_page_cache, bool kept_in_memory,
626
63
                                          const ColumnIteratorOptions& iter_opts) {
627
63
    if (_zone_map_index != nullptr) {
628
63
        return _zone_map_index->load(use_page_cache, kept_in_memory, iter_opts.stats);
629
63
    }
630
0
    return Status::OK();
631
63
}
632
633
Status ColumnReader::_load_index(const std::shared_ptr<IndexFileReader>& index_file_reader,
634
                                 const TabletIndex* index_meta, const std::string& rowset_id,
635
2.67k
                                 uint32_t segment_id, size_t rows_of_segment) {
636
2.67k
    std::unique_lock<std::shared_mutex> wlock(_load_index_lock);
637
638
2.67k
    if (index_meta == nullptr) {
639
0
        return Status::Error<ErrorCode::INVERTED_INDEX_CLUCENE_ERROR>(
640
0
                "Failed to load inverted index: index metadata is null");
641
0
    }
642
643
2.67k
    auto it = _index_readers.find(index_meta->index_id());
644
2.67k
    if (it != _index_readers.end()) {
645
0
        return Status::OK();
646
0
    }
647
648
2.67k
    bool should_analyzer =
649
2.67k
            inverted_index::InvertedIndexAnalyzer::should_analyzer(index_meta->properties());
650
651
2.67k
    FieldType type;
652
2.67k
    if (_meta_type == FieldType::OLAP_FIELD_TYPE_ARRAY) {
653
22
        type = _meta_children_column_type;
654
2.65k
    } else {
655
2.65k
        type = _type;
656
2.65k
    }
657
658
2.67k
    if (index_meta->index_type() == IndexType::ANN) {
659
1
        _index_readers[index_meta->index_id()] = std::make_shared<AnnIndexReader>(
660
1
                index_meta, index_file_reader, rowset_id, segment_id, rows_of_segment);
661
1
        return Status::OK();
662
1
    }
663
664
2.67k
    IndexReaderPtr index_reader;
665
666
2.67k
    if (is_string_type(type)) {
667
2.24k
        if (should_analyzer) {
668
1.69k
            try {
669
1.69k
                index_reader = FullTextIndexReader::create_shared(index_meta, index_file_reader);
670
1.69k
            } catch (const CLuceneError& e) {
671
0
                return Status::Error<ErrorCode::INVERTED_INDEX_CLUCENE_ERROR>(
672
0
                        "create FullTextIndexReader error: {}", e.what());
673
0
            }
674
1.69k
        } else {
675
545
            try {
676
545
                index_reader =
677
545
                        StringTypeInvertedIndexReader::create_shared(index_meta, index_file_reader);
678
545
            } catch (const CLuceneError& e) {
679
0
                return Status::Error<ErrorCode::INVERTED_INDEX_CLUCENE_ERROR>(
680
0
                        "create StringTypeInvertedIndexReader error: {}", e.what());
681
0
            }
682
545
        }
683
2.24k
    } else if (is_numeric_type(type)) {
684
433
        try {
685
433
            index_reader = BkdIndexReader::create_shared(index_meta, index_file_reader);
686
433
        } catch (const CLuceneError& e) {
687
0
            return Status::Error<ErrorCode::INVERTED_INDEX_CLUCENE_ERROR>(
688
0
                    "create BkdIndexReader error: {}", e.what());
689
0
        }
690
433
    } else {
691
0
        return Status::Error<ErrorCode::INVERTED_INDEX_NOT_SUPPORTED>(
692
0
                "Field type {} is not supported for inverted index", type);
693
0
    }
694
2.67k
    _index_readers[index_meta->index_id()] = index_reader;
695
2.67k
    return Status::OK();
696
2.67k
}
697
698
48
bool ColumnReader::has_bloom_filter_index(bool ngram) const {
699
48
    if (_bloom_filter_index == nullptr) return false;
700
701
3
    if (ngram) {
702
0
        return _bloom_filter_index->algorithm() == BloomFilterAlgorithmPB::NGRAM_BLOOM_FILTER;
703
3
    } else {
704
3
        return _bloom_filter_index->algorithm() != BloomFilterAlgorithmPB::NGRAM_BLOOM_FILTER;
705
3
    }
706
3
}
707
708
Status ColumnReader::_load_bloom_filter_index(bool use_page_cache, bool kept_in_memory,
709
3
                                              const ColumnIteratorOptions& iter_opts) {
710
3
    if (_bloom_filter_index != nullptr) {
711
3
        return _bloom_filter_index->load(use_page_cache, kept_in_memory, iter_opts.stats);
712
3
    }
713
0
    return Status::OK();
714
3
}
715
716
Status ColumnReader::seek_at_or_before(ordinal_t ordinal, OrdinalPageIndexIterator* iter,
717
9.06k
                                       const ColumnIteratorOptions& iter_opts) {
718
9.06k
    RETURN_IF_ERROR(_load_ordinal_index(_use_index_page_cache, _opts.kept_in_memory, iter_opts));
719
9.06k
    *iter = _ordinal_index->seek_at_or_before(ordinal);
720
9.06k
    if (!iter->valid()) {
721
0
        return Status::NotFound("Failed to seek to ordinal {}, ", ordinal);
722
0
    }
723
9.06k
    return Status::OK();
724
9.06k
}
725
726
Status ColumnReader::get_ordinal_index_reader(OrdinalIndexReader*& reader,
727
0
                                              OlapReaderStatistics* index_load_stats) {
728
0
    CHECK(_ordinal_index) << fmt::format("ordinal index is null for column reader of type {}",
729
0
                                         std::to_string(int(_meta_type)));
730
0
    RETURN_IF_ERROR(
731
0
            _ordinal_index->load(_use_index_page_cache, _opts.kept_in_memory, index_load_stats));
732
0
    reader = _ordinal_index.get();
733
0
    return Status::OK();
734
0
}
735
736
1.75k
Status ColumnReader::new_iterator(ColumnIteratorUPtr* iterator, const TabletColumn* tablet_column) {
737
1.75k
    return new_iterator(iterator, tablet_column, nullptr);
738
1.75k
}
739
740
Status ColumnReader::new_iterator(ColumnIteratorUPtr* iterator, const TabletColumn* tablet_column,
741
8.88k
                                  const StorageReadOptions* opt) {
742
8.88k
    if (is_empty()) {
743
150
        *iterator = std::make_unique<EmptyFileColumnIterator>();
744
150
        return Status::OK();
745
150
    }
746
8.73k
    if (is_scalar_type(_meta_type)) {
747
8.42k
        if (is_string_type(_meta_type)) {
748
2.91k
            *iterator = std::make_unique<StringFileColumnIterator>(shared_from_this());
749
5.50k
        } else {
750
5.50k
            *iterator = std::make_unique<FileColumnIterator>(shared_from_this());
751
5.50k
        }
752
8.42k
        (*iterator)->set_column_name(tablet_column ? tablet_column->name() : "");
753
8.42k
        return Status::OK();
754
8.42k
    } else {
755
311
        auto type = _meta_type;
756
311
        switch (type) {
757
0
        case FieldType::OLAP_FIELD_TYPE_AGG_STATE: {
758
0
            return new_agg_state_iterator(iterator);
759
0
        }
760
0
        case FieldType::OLAP_FIELD_TYPE_STRUCT: {
761
0
            return new_struct_iterator(iterator, tablet_column);
762
0
        }
763
31
        case FieldType::OLAP_FIELD_TYPE_ARRAY: {
764
31
            return new_array_iterator(iterator, tablet_column);
765
0
        }
766
280
        case FieldType::OLAP_FIELD_TYPE_MAP: {
767
280
            return new_map_iterator(iterator, tablet_column);
768
0
        }
769
0
        default:
770
0
            return Status::NotSupported("unsupported type to create iterator: {}",
771
0
                                        std::to_string(int(type)));
772
311
        }
773
311
    }
774
8.73k
}
775
776
0
Status ColumnReader::new_agg_state_iterator(ColumnIteratorUPtr* iterator) {
777
0
    *iterator = std::make_unique<FileColumnIterator>(shared_from_this());
778
0
    return Status::OK();
779
0
}
780
781
Status ColumnReader::new_array_iterator(ColumnIteratorUPtr* iterator,
782
31
                                        const TabletColumn* tablet_column) {
783
31
    ColumnIteratorUPtr item_iterator;
784
31
    RETURN_IF_ERROR(_sub_readers[0]->new_iterator(
785
31
            &item_iterator, tablet_column && tablet_column->get_subtype_count() > 0
786
31
                                    ? &tablet_column->get_sub_column(0)
787
31
                                    : nullptr));
788
789
31
    item_iterator->set_column_name(tablet_column ? tablet_column->get_sub_column(0).name() : "");
790
791
31
    ColumnIteratorUPtr offset_iterator;
792
31
    RETURN_IF_ERROR(_sub_readers[1]->new_iterator(&offset_iterator, nullptr));
793
31
    auto* file_iter = static_cast<FileColumnIterator*>(offset_iterator.release());
794
31
    OffsetFileColumnIteratorUPtr ofcIter = std::make_unique<OffsetFileColumnIterator>(
795
31
            std::unique_ptr<FileColumnIterator>(file_iter));
796
797
31
    ColumnIteratorUPtr null_iterator;
798
31
    if (is_nullable()) {
799
29
        RETURN_IF_ERROR(_sub_readers[2]->new_iterator(&null_iterator, nullptr));
800
29
    }
801
31
    *iterator = std::make_unique<ArrayFileColumnIterator>(shared_from_this(), std::move(ofcIter),
802
31
                                                          std::move(item_iterator),
803
31
                                                          std::move(null_iterator));
804
31
    return Status::OK();
805
31
}
806
807
Status ColumnReader::new_map_iterator(ColumnIteratorUPtr* iterator,
808
280
                                      const TabletColumn* tablet_column) {
809
280
    ColumnIteratorUPtr key_iterator;
810
280
    RETURN_IF_ERROR(_sub_readers[0]->new_iterator(
811
280
            &key_iterator, tablet_column && tablet_column->get_subtype_count() > 1
812
280
                                   ? &tablet_column->get_sub_column(0)
813
280
                                   : nullptr));
814
280
    key_iterator->set_column_name(tablet_column ? tablet_column->get_sub_column(0).name() : "");
815
280
    ColumnIteratorUPtr val_iterator;
816
280
    RETURN_IF_ERROR(_sub_readers[1]->new_iterator(
817
280
            &val_iterator, tablet_column && tablet_column->get_subtype_count() > 1
818
280
                                   ? &tablet_column->get_sub_column(1)
819
280
                                   : nullptr));
820
280
    val_iterator->set_column_name(tablet_column ? tablet_column->get_sub_column(1).name() : "");
821
280
    ColumnIteratorUPtr offsets_iterator;
822
280
    RETURN_IF_ERROR(_sub_readers[2]->new_iterator(&offsets_iterator, nullptr));
823
280
    auto* file_iter = static_cast<FileColumnIterator*>(offsets_iterator.release());
824
280
    OffsetFileColumnIteratorUPtr ofcIter = std::make_unique<OffsetFileColumnIterator>(
825
280
            std::unique_ptr<FileColumnIterator>(file_iter));
826
827
280
    ColumnIteratorUPtr null_iterator;
828
280
    if (is_nullable()) {
829
0
        RETURN_IF_ERROR(_sub_readers[3]->new_iterator(&null_iterator, nullptr));
830
0
    }
831
280
    *iterator = std::make_unique<MapFileColumnIterator>(
832
280
            shared_from_this(), std::move(null_iterator), std::move(ofcIter),
833
280
            std::move(key_iterator), std::move(val_iterator));
834
280
    return Status::OK();
835
280
}
836
837
Status ColumnReader::new_struct_iterator(ColumnIteratorUPtr* iterator,
838
0
                                         const TabletColumn* tablet_column) {
839
0
    std::vector<ColumnIteratorUPtr> sub_column_iterators;
840
0
    size_t child_size = is_nullable() ? _sub_readers.size() - 1 : _sub_readers.size();
841
0
    size_t tablet_column_size = tablet_column ? tablet_column->get_sub_columns().size() : 0;
842
0
    sub_column_iterators.reserve(child_size);
843
844
0
    for (uint64_t i = 0; i < child_size; i++) {
845
0
        ColumnIteratorUPtr sub_column_iterator;
846
0
        RETURN_IF_ERROR(_sub_readers[i]->new_iterator(
847
0
                &sub_column_iterator, tablet_column ? &tablet_column->get_sub_column(i) : nullptr));
848
0
        sub_column_iterator->set_column_name(tablet_column ? tablet_column->get_sub_column(i).name()
849
0
                                                           : "");
850
0
        sub_column_iterators.emplace_back(std::move(sub_column_iterator));
851
0
    }
852
853
    // create default_iterator for schema-change behavior which increase column
854
0
    for (size_t i = child_size; i < tablet_column_size; i++) {
855
0
        TabletColumn column = tablet_column->get_sub_column(i);
856
0
        ColumnIteratorUPtr it;
857
0
        RETURN_IF_ERROR(Segment::new_default_iterator(column, &it));
858
0
        it->set_column_name(column.name());
859
0
        sub_column_iterators.emplace_back(std::move(it));
860
0
    }
861
862
0
    ColumnIteratorUPtr null_iterator;
863
0
    if (is_nullable()) {
864
0
        RETURN_IF_ERROR(_sub_readers[child_size]->new_iterator(&null_iterator, nullptr));
865
0
    }
866
0
    *iterator = std::make_unique<StructFileColumnIterator>(
867
0
            shared_from_this(), std::move(null_iterator), std::move(sub_column_iterators));
868
0
    return Status::OK();
869
0
}
870
871
Result<TColumnAccessPaths> ColumnIterator::_get_sub_access_paths(
872
16
        const TColumnAccessPaths& access_paths) {
873
16
    TColumnAccessPaths sub_access_paths = access_paths;
874
26
    for (auto it = sub_access_paths.begin(); it != sub_access_paths.end();) {
875
12
        TColumnAccessPath& name_path = *it;
876
12
        if (name_path.data_access_path.path.empty()) {
877
1
            return ResultError(
878
1
                    Status::InternalError("Invalid access path for struct column: path is empty"));
879
1
        }
880
881
11
        if (!StringCaseEqual()(name_path.data_access_path.path[0], _column_name)) {
882
1
            return ResultError(Status::InternalError(
883
1
                    R"(Invalid access path for column: expected name "{}", got "{}")", _column_name,
884
1
                    name_path.data_access_path.path[0]));
885
1
        }
886
887
10
        name_path.data_access_path.path.erase(name_path.data_access_path.path.begin());
888
10
        if (!name_path.data_access_path.path.empty()) {
889
8
            ++it;
890
8
        } else {
891
2
            set_need_to_read();
892
2
            it = sub_access_paths.erase(it);
893
2
        }
894
10
    }
895
14
    return sub_access_paths;
896
16
}
897
898
///====================== MapFileColumnIterator ============================////
899
MapFileColumnIterator::MapFileColumnIterator(std::shared_ptr<ColumnReader> reader,
900
                                             ColumnIteratorUPtr null_iterator,
901
                                             OffsetFileColumnIteratorUPtr offsets_iterator,
902
                                             ColumnIteratorUPtr key_iterator,
903
                                             ColumnIteratorUPtr val_iterator)
904
283
        : _map_reader(reader),
905
283
          _offsets_iterator(std::move(offsets_iterator)),
906
283
          _key_iterator(std::move(key_iterator)),
907
283
          _val_iterator(std::move(val_iterator)) {
908
283
    if (_map_reader->is_nullable()) {
909
0
        _null_iterator = std::move(null_iterator);
910
0
    }
911
283
}
912
913
276
Status MapFileColumnIterator::init(const ColumnIteratorOptions& opts) {
914
276
    if (_reading_flag == ReadingFlag::SKIP_READING) {
915
0
        DLOG(INFO) << "Map column iterator column " << _column_name << " skip reading.";
916
0
        return Status::OK();
917
0
    }
918
276
    RETURN_IF_ERROR(_key_iterator->init(opts));
919
276
    RETURN_IF_ERROR(_val_iterator->init(opts));
920
276
    RETURN_IF_ERROR(_offsets_iterator->init(opts));
921
276
    if (_map_reader->is_nullable()) {
922
0
        RETURN_IF_ERROR(_null_iterator->init(opts));
923
0
    }
924
276
    return Status::OK();
925
276
}
926
927
264
Status MapFileColumnIterator::seek_to_ordinal(ordinal_t ord) {
928
264
    if (_reading_flag == ReadingFlag::SKIP_READING) {
929
0
        DLOG(INFO) << "Map column iterator column " << _column_name << " skip reading.";
930
0
        return Status::OK();
931
0
    }
932
933
264
    if (read_null_map_only()) {
934
        // In NULL_MAP_ONLY mode, only seek the null iterator; skip offset/key/val iterators
935
0
        if (_map_reader->is_nullable() && _null_iterator) {
936
0
            RETURN_IF_ERROR(_null_iterator->seek_to_ordinal(ord));
937
0
        }
938
0
        return Status::OK();
939
0
    }
940
941
264
    if (_map_reader->is_nullable()) {
942
0
        RETURN_IF_ERROR(_null_iterator->seek_to_ordinal(ord));
943
0
    }
944
264
    RETURN_IF_ERROR(_offsets_iterator->seek_to_ordinal(ord));
945
264
    if (read_offset_only()) {
946
        // In OFFSET_ONLY mode, key/value iterators are SKIP_READING, no need to seek them
947
0
        return Status::OK();
948
0
    }
949
    // here to use offset info
950
264
    ordinal_t offset = 0;
951
264
    RETURN_IF_ERROR(_offsets_iterator->_peek_one_offset(&offset));
952
264
    RETURN_IF_ERROR(_key_iterator->seek_to_ordinal(offset));
953
264
    RETURN_IF_ERROR(_val_iterator->seek_to_ordinal(offset));
954
264
    return Status::OK();
955
264
}
956
957
0
Status MapFileColumnIterator::init_prefetcher(const SegmentPrefetchParams& params) {
958
0
    RETURN_IF_ERROR(_offsets_iterator->init_prefetcher(params));
959
0
    if (_map_reader->is_nullable()) {
960
0
        RETURN_IF_ERROR(_null_iterator->init_prefetcher(params));
961
0
    }
962
0
    RETURN_IF_ERROR(_key_iterator->init_prefetcher(params));
963
0
    RETURN_IF_ERROR(_val_iterator->init_prefetcher(params));
964
0
    return Status::OK();
965
0
}
966
967
void MapFileColumnIterator::collect_prefetchers(
968
        std::map<PrefetcherInitMethod, std::vector<SegmentPrefetcher*>>& prefetchers,
969
0
        PrefetcherInitMethod init_method) {
970
0
    _offsets_iterator->collect_prefetchers(prefetchers, init_method);
971
0
    if (_map_reader->is_nullable()) {
972
0
        _null_iterator->collect_prefetchers(prefetchers, init_method);
973
0
    }
974
    // the actual data pages to read of key/value column depends on the read result of offset column,
975
    // so we can't init prefetch blocks according to rowids, just prefetch all data blocks here.
976
0
    _key_iterator->collect_prefetchers(prefetchers, PrefetcherInitMethod::ALL_DATA_BLOCKS);
977
0
    _val_iterator->collect_prefetchers(prefetchers, PrefetcherInitMethod::ALL_DATA_BLOCKS);
978
0
}
979
980
263
Status MapFileColumnIterator::next_batch(size_t* n, MutableColumnPtr& dst, bool* has_null) {
981
263
    if (_reading_flag == ReadingFlag::SKIP_READING) {
982
0
        DLOG(INFO) << "Map column iterator column " << _column_name << " skip reading.";
983
0
        dst->insert_many_defaults(*n);
984
0
        return Status::OK();
985
0
    }
986
987
263
    if (read_null_map_only()) {
988
        // NULL_MAP_ONLY mode: read null map, fill nested ColumnMap with empty defaults
989
0
        DORIS_CHECK(is_column_nullable(*dst));
990
0
        auto& nullable_col = assert_cast<ColumnNullable&>(*dst);
991
0
        auto null_map_ptr = nullable_col.get_null_map_column_ptr();
992
0
        size_t num_read = *n;
993
0
        if (_null_iterator) {
994
0
            bool null_signs_has_null = false;
995
0
            MutableColumnPtr null_map_column = std::move(null_map_ptr);
996
0
            RETURN_IF_ERROR(
997
0
                    _null_iterator->next_batch(&num_read, null_map_column, &null_signs_has_null));
998
0
        } else {
999
            // schema-change: column became nullable but old segment has no null data
1000
0
            null_map_ptr->insert_many_vals(0, num_read);
1001
0
        }
1002
0
        DCHECK(num_read == *n);
1003
        // fill nested ColumnMap with empty (zero-element) maps
1004
0
        auto& column_map = assert_cast<ColumnMap&, TypeCheckOnRelease::DISABLE>(
1005
0
                nullable_col.get_nested_column());
1006
0
        column_map.insert_many_defaults(num_read);
1007
0
        *has_null = true;
1008
0
        return Status::OK();
1009
0
    }
1010
1011
263
    auto& column_map = assert_cast<ColumnMap&, TypeCheckOnRelease::DISABLE>(
1012
263
            is_column_nullable(*dst) ? static_cast<ColumnNullable&>(*dst).get_nested_column()
1013
263
                                     : *dst);
1014
263
    auto column_offsets_ptr = IColumn::mutate(std::move(column_map.get_offsets_ptr()));
1015
263
    Defer defer_offsets {[&] {
1016
263
        auto typed_column_offsets_ptr = ColumnMap::COffsets::cast_to_column_mutptr(
1017
263
                assert_cast<ColumnMap::COffsets*, TypeCheckOnRelease::DISABLE>(
1018
263
                        column_offsets_ptr.get()));
1019
263
        column_offsets_ptr = nullptr;
1020
263
        column_map.get_offsets_ptr() = std::move(typed_column_offsets_ptr);
1021
263
    }};
1022
263
    bool offsets_has_null = false;
1023
263
    ssize_t start = column_offsets_ptr->size();
1024
263
    RETURN_IF_ERROR(_offsets_iterator->next_batch(n, column_offsets_ptr, &offsets_has_null));
1025
263
    if (*n == 0) {
1026
0
        return Status::OK();
1027
0
    }
1028
263
    auto& column_offsets = static_cast<ColumnArray::ColumnOffsets&>(*column_offsets_ptr);
1029
263
    RETURN_IF_ERROR(_offsets_iterator->_calculate_offsets(start, column_offsets));
1030
263
    DCHECK(column_offsets.get_data().back() >= column_offsets.get_data()[start - 1]);
1031
263
    size_t num_items =
1032
263
            column_offsets.get_data().back() - column_offsets.get_data()[start - 1]; // -1 is valid
1033
1034
263
    if (num_items > 0) {
1035
204
        auto key_ptr = IColumn::mutate(std::move(column_map.get_keys_ptr()));
1036
204
        auto val_ptr = IColumn::mutate(std::move(column_map.get_values_ptr()));
1037
204
        Defer defer_keys {[&] { column_map.get_keys_ptr() = std::move(key_ptr); }};
1038
204
        Defer defer_values {[&] { column_map.get_values_ptr() = std::move(val_ptr); }};
1039
204
        if (read_offset_only()) {
1040
            // OFFSET_ONLY mode: skip reading actual key/value data, fill with defaults
1041
0
            key_ptr->insert_many_defaults(num_items);
1042
0
            val_ptr->insert_many_defaults(num_items);
1043
204
        } else {
1044
204
            size_t num_read = num_items;
1045
204
            bool key_has_null = false;
1046
204
            bool val_has_null = false;
1047
204
            RETURN_IF_ERROR(_key_iterator->next_batch(&num_read, key_ptr, &key_has_null));
1048
204
            RETURN_IF_ERROR(_val_iterator->next_batch(&num_read, val_ptr, &val_has_null));
1049
204
            DCHECK(num_read == num_items);
1050
204
        }
1051
204
    }
1052
1053
263
    if (is_column_nullable(*dst)) {
1054
0
        size_t num_read = *n;
1055
0
        auto null_map_ptr = static_cast<ColumnNullable&>(*dst).get_null_map_column_ptr();
1056
        // in not-null to null linked-schemachange mode,
1057
        // actually we do not change dat data include meta in footer,
1058
        // so may dst from changed meta which is nullable but old data is not nullable,
1059
        // if so, we should set null_map to all null by default
1060
0
        if (_null_iterator) {
1061
0
            bool null_signs_has_null = false;
1062
0
            MutableColumnPtr null_map_column = std::move(null_map_ptr);
1063
0
            RETURN_IF_ERROR(
1064
0
                    _null_iterator->next_batch(&num_read, null_map_column, &null_signs_has_null));
1065
0
        } else {
1066
0
            null_map_ptr->insert_many_vals(0, num_read);
1067
0
        }
1068
0
        DCHECK(num_read == *n);
1069
0
    }
1070
263
    return Status::OK();
1071
263
}
1072
1073
Status MapFileColumnIterator::read_by_rowids(const rowid_t* rowids, const size_t count,
1074
21
                                             MutableColumnPtr& dst) {
1075
21
    if (_reading_flag == ReadingFlag::SKIP_READING) {
1076
1
        DLOG(INFO) << "File column iterator column " << _column_name << " skip reading.";
1077
1
        dst->insert_many_defaults(count);
1078
1
        return Status::OK();
1079
1
    }
1080
1081
20
    if (read_null_map_only()) {
1082
        // NULL_MAP_ONLY mode: read null map by rowids, fill nested ColumnMap with empty defaults
1083
0
        DORIS_CHECK(is_column_nullable(*dst));
1084
0
        auto& nullable_col = assert_cast<ColumnNullable&>(*dst);
1085
0
        if (_null_iterator) {
1086
0
            auto null_map_ptr = nullable_col.get_null_map_column_ptr();
1087
0
            MutableColumnPtr null_map_column = std::move(null_map_ptr);
1088
0
            RETURN_IF_ERROR(_null_iterator->read_by_rowids(rowids, count, null_map_column));
1089
0
        } else {
1090
            // schema-change: column became nullable but old segment has no null data
1091
0
            auto null_map_ptr = nullable_col.get_null_map_column_ptr();
1092
0
            null_map_ptr->insert_many_vals(0, count);
1093
0
        }
1094
        // fill nested ColumnMap with empty (zero-element) maps
1095
0
        auto& column_map = assert_cast<ColumnMap&, TypeCheckOnRelease::DISABLE>(
1096
0
                nullable_col.get_nested_column());
1097
0
        column_map.insert_many_defaults(count);
1098
0
        return Status::OK();
1099
0
    }
1100
1101
20
    if (count == 0) {
1102
0
        return Status::OK();
1103
0
    }
1104
    // resolve ColumnMap and nullable wrapper
1105
20
    auto& column_map = assert_cast<ColumnMap&, TypeCheckOnRelease::DISABLE>(
1106
20
            is_column_nullable(*dst) ? static_cast<ColumnNullable&>(*dst).get_nested_column()
1107
20
                                     : *dst);
1108
20
    auto offsets_ptr = IColumn::mutate(std::move(column_map.get_offsets_ptr()));
1109
20
    Defer defer_offsets {[&] {
1110
20
        auto typed_offsets_ptr = ColumnMap::COffsets::cast_to_column_mutptr(
1111
20
                assert_cast<ColumnMap::COffsets*, TypeCheckOnRelease::DISABLE>(offsets_ptr.get()));
1112
20
        offsets_ptr = nullptr;
1113
20
        column_map.get_offsets_ptr() = std::move(typed_offsets_ptr);
1114
20
    }};
1115
20
    auto& offsets = static_cast<ColumnArray::ColumnOffsets&>(*offsets_ptr);
1116
20
    size_t base = offsets.get_data().empty() ? 0 : offsets.get_data().back();
1117
1118
    // 1. bulk read null-map if nullable
1119
20
    std::vector<uint8_t> null_mask; // 0: not null, 1: null
1120
20
    if (_map_reader->is_nullable()) {
1121
        // For nullable map columns, the destination column must also be nullable.
1122
0
        if (UNLIKELY(!is_column_nullable(*dst))) {
1123
0
            return Status::InternalError(
1124
0
                    "unexpected non-nullable destination column for nullable map reader");
1125
0
        }
1126
0
        auto null_map_ptr = static_cast<ColumnNullable&>(*dst).get_null_map_column_ptr();
1127
0
        size_t null_before = null_map_ptr->size();
1128
0
        auto* null_map_col = null_map_ptr.get();
1129
0
        MutableColumnPtr null_map_column = std::move(null_map_ptr);
1130
0
        RETURN_IF_ERROR(_null_iterator->read_by_rowids(rowids, count, null_map_column));
1131
        // extract a light-weight view to decide element reads
1132
0
        null_mask.reserve(count);
1133
0
        for (size_t i = 0; i < count; ++i) {
1134
0
            null_mask.push_back(null_map_col->get_element(null_before + i));
1135
0
        }
1136
20
    } else if (is_column_nullable(*dst)) {
1137
        // in not-null to null linked-schemachange mode,
1138
        // actually we do not change dat data include meta in footer,
1139
        // so may dst from changed meta which is nullable but old data is not nullable,
1140
        // if so, we should set null_map to all null by default
1141
0
        auto null_map_ptr = static_cast<ColumnNullable&>(*dst).get_null_map_column_ptr();
1142
0
        null_map_ptr->insert_many_vals(0, count);
1143
0
    }
1144
1145
    // 2. bulk read start ordinals for requested rows
1146
20
    MutableColumnPtr starts_col = ColumnOffset64::create();
1147
20
    starts_col->reserve(count);
1148
20
    RETURN_IF_ERROR(_offsets_iterator->read_by_rowids(rowids, count, starts_col));
1149
1150
    // 3. bulk read next-start ordinals for rowid+1 (within bounds)
1151
20
    std::vector<rowid_t> next_rowids(count);
1152
2.89k
    for (size_t i = 0; i < count; ++i) {
1153
2.87k
        uint64_t nr = rowids[i] + 1;
1154
2.87k
        next_rowids[i] = nr < _map_reader->num_rows() ? static_cast<rowid_t>(nr)
1155
2.87k
                                                      : static_cast<rowid_t>(0); // placeholder
1156
2.87k
    }
1157
20
    MutableColumnPtr next_starts_col = ColumnOffset64::create();
1158
20
    next_starts_col->reserve(count);
1159
    // read for all; we'll fix out-of-bound cases below
1160
20
    RETURN_IF_ERROR(_offsets_iterator->read_by_rowids(next_rowids.data(), count, next_starts_col));
1161
1162
    // 4. fix next_start for rows whose next_rowid is out-of-bound (rowid == num_rows-1)
1163
2.89k
    for (size_t i = 0; i < count; ++i) {
1164
2.87k
        if (rowids[i] + 1 >= _map_reader->num_rows()) {
1165
            // seek to the last row and consume one to move decoder to end-of-page,
1166
            // then peek page-tail sentinel next_array_item_ordinal as next_start
1167
13
            RETURN_IF_ERROR(_offsets_iterator->seek_to_ordinal(rowids[i]));
1168
13
            size_t one = 1;
1169
13
            bool has_null_unused = false;
1170
13
            MutableColumnPtr tmp = ColumnOffset64::create();
1171
13
            RETURN_IF_ERROR(_offsets_iterator->next_batch(&one, tmp, &has_null_unused));
1172
13
            ordinal_t ns = 0;
1173
13
            RETURN_IF_ERROR(_offsets_iterator->_peek_one_offset(&ns));
1174
            // overwrite with sentinel
1175
13
            assert_cast<ColumnOffset64&, TypeCheckOnRelease::DISABLE>(*next_starts_col)
1176
13
                    .get_data()[i] = ns;
1177
13
        }
1178
2.87k
    }
1179
1180
    // 5. compute sizes and append offsets prefix-sum
1181
20
    auto& starts_data = assert_cast<ColumnOffset64&>(*starts_col).get_data();
1182
20
    auto& next_starts_data = assert_cast<ColumnOffset64&>(*next_starts_col).get_data();
1183
20
    std::vector<size_t> sizes(count, 0);
1184
20
    size_t acc = base;
1185
20
    const auto original_size = offsets.get_data().back();
1186
20
    offsets.get_data().reserve(offsets.get_data().size() + count);
1187
2.89k
    for (size_t i = 0; i < count; ++i) {
1188
2.87k
        size_t sz = static_cast<size_t>(next_starts_data[i] - starts_data[i]);
1189
2.87k
        if (_map_reader->is_nullable() && !null_mask.empty() && null_mask[i]) {
1190
0
            sz = 0; // null rows do not consume elements
1191
0
        }
1192
2.87k
        sizes[i] = sz;
1193
2.87k
        acc += sz;
1194
2.87k
        offsets.get_data().push_back(acc);
1195
2.87k
    }
1196
1197
    // 6. read key/value elements for non-empty sizes
1198
20
    auto keys_ptr = IColumn::mutate(std::move(column_map.get_keys_ptr()));
1199
20
    auto vals_ptr = IColumn::mutate(std::move(column_map.get_values_ptr()));
1200
20
    Defer defer_keys {[&] { column_map.get_keys_ptr() = std::move(keys_ptr); }};
1201
20
    Defer defer_values {[&] { column_map.get_values_ptr() = std::move(vals_ptr); }};
1202
1203
20
    size_t this_run = sizes[0];
1204
20
    auto start_idx = starts_data[0];
1205
20
    auto last_idx = starts_data[0] + this_run;
1206
2.87k
    for (size_t i = 1; i < count; ++i) {
1207
2.85k
        size_t sz = sizes[i];
1208
2.85k
        if (sz == 0) {
1209
2.56k
            continue;
1210
2.56k
        }
1211
291
        auto start = static_cast<ordinal_t>(starts_data[i]);
1212
291
        if (start != last_idx) {
1213
286
            size_t n = this_run;
1214
286
            bool dummy_has_null = false;
1215
1216
286
            if (this_run != 0) {
1217
285
                if (_key_iterator->reading_flag() != ReadingFlag::SKIP_READING) {
1218
285
                    RETURN_IF_ERROR(_key_iterator->seek_to_ordinal(start_idx));
1219
285
                    RETURN_IF_ERROR(_key_iterator->next_batch(&n, keys_ptr, &dummy_has_null));
1220
285
                    DCHECK(n == this_run);
1221
285
                }
1222
1223
285
                if (_val_iterator->reading_flag() != ReadingFlag::SKIP_READING) {
1224
285
                    n = this_run;
1225
285
                    RETURN_IF_ERROR(_val_iterator->seek_to_ordinal(start_idx));
1226
285
                    RETURN_IF_ERROR(_val_iterator->next_batch(&n, vals_ptr, &dummy_has_null));
1227
285
                    DCHECK(n == this_run);
1228
285
                }
1229
285
            }
1230
286
            start_idx = start;
1231
286
            this_run = sz;
1232
286
            last_idx = start + sz;
1233
286
            continue;
1234
286
        }
1235
1236
5
        this_run += sz;
1237
5
        last_idx += sz;
1238
5
    }
1239
1240
20
    size_t n = this_run;
1241
20
    const size_t total_count = offsets.get_data().back() - original_size;
1242
20
    bool dummy_has_null = false;
1243
20
    if (_key_iterator->reading_flag() != ReadingFlag::SKIP_READING) {
1244
20
        if (this_run != 0) {
1245
4
            RETURN_IF_ERROR(_key_iterator->seek_to_ordinal(start_idx));
1246
4
            RETURN_IF_ERROR(_key_iterator->next_batch(&n, keys_ptr, &dummy_has_null));
1247
4
            DCHECK(n == this_run);
1248
4
        }
1249
20
    } else {
1250
0
        keys_ptr->insert_many_defaults(total_count);
1251
0
    }
1252
1253
20
    if (_val_iterator->reading_flag() != ReadingFlag::SKIP_READING) {
1254
20
        if (this_run != 0) {
1255
4
            n = this_run;
1256
4
            RETURN_IF_ERROR(_val_iterator->seek_to_ordinal(start_idx));
1257
4
            RETURN_IF_ERROR(_val_iterator->next_batch(&n, vals_ptr, &dummy_has_null));
1258
4
            DCHECK(n == this_run);
1259
4
        }
1260
20
    } else {
1261
0
        vals_ptr->insert_many_defaults(total_count);
1262
0
    }
1263
1264
20
    return Status::OK();
1265
20
}
1266
1267
0
void MapFileColumnIterator::set_need_to_read() {
1268
0
    set_reading_flag(ReadingFlag::NEED_TO_READ);
1269
0
    _key_iterator->set_need_to_read();
1270
0
    _val_iterator->set_need_to_read();
1271
0
}
1272
1273
0
void MapFileColumnIterator::remove_pruned_sub_iterators() {
1274
0
    _key_iterator->remove_pruned_sub_iterators();
1275
0
    _val_iterator->remove_pruned_sub_iterators();
1276
0
}
1277
1278
Status MapFileColumnIterator::set_access_paths(const TColumnAccessPaths& all_access_paths,
1279
2
                                               const TColumnAccessPaths& predicate_access_paths) {
1280
2
    if (all_access_paths.empty()) {
1281
0
        return Status::OK();
1282
0
    }
1283
1284
2
    if (!predicate_access_paths.empty()) {
1285
0
        set_reading_flag(ReadingFlag::READING_FOR_PREDICATE);
1286
0
        DLOG(INFO) << "Map column iterator set sub-column " << _column_name
1287
0
                   << " to READING_FOR_PREDICATE";
1288
0
    }
1289
1290
2
    auto sub_all_access_paths = DORIS_TRY(_get_sub_access_paths(all_access_paths));
1291
2
    auto sub_predicate_access_paths = DORIS_TRY(_get_sub_access_paths(predicate_access_paths));
1292
1293
2
    if (sub_all_access_paths.empty()) {
1294
0
        return Status::OK();
1295
0
    }
1296
1297
    // Check for meta-only modes (OFFSET_ONLY or NULL_MAP_ONLY)
1298
2
    _check_and_set_meta_read_mode(sub_all_access_paths);
1299
2
    if (read_offset_only()) {
1300
0
        _key_iterator->set_reading_flag(ReadingFlag::SKIP_READING);
1301
0
        _val_iterator->set_reading_flag(ReadingFlag::SKIP_READING);
1302
0
        DLOG(INFO) << "Map column iterator set column " << _column_name
1303
0
                   << " to OFFSET_ONLY reading mode, key/value columns set to SKIP_READING";
1304
0
        return Status::OK();
1305
0
    }
1306
2
    if (read_null_map_only()) {
1307
0
        _key_iterator->set_reading_flag(ReadingFlag::SKIP_READING);
1308
0
        _val_iterator->set_reading_flag(ReadingFlag::SKIP_READING);
1309
0
        DLOG(INFO) << "Map column iterator set column " << _column_name
1310
0
                   << " to NULL_MAP_ONLY reading mode, key/value columns set to SKIP_READING";
1311
0
        return Status::OK();
1312
0
    }
1313
1314
2
    TColumnAccessPaths key_all_access_paths;
1315
2
    TColumnAccessPaths val_all_access_paths;
1316
2
    TColumnAccessPaths key_predicate_access_paths;
1317
2
    TColumnAccessPaths val_predicate_access_paths;
1318
1319
2
    for (auto paths : sub_all_access_paths) {
1320
2
        if (paths.data_access_path.path[0] == ACCESS_ALL) {
1321
            // ACCESS_ALL means element_at(map, key) style access: the key column must be
1322
            // fully read so that the runtime can match the requested key, while any sub-path
1323
            // qualifiers (e.g. OFFSET) apply only to the value column.
1324
            // For key: create a path with just the column name (= full data access).
1325
1
            TColumnAccessPath key_path;
1326
1
            key_path.__set_type(paths.type);
1327
1
            TDataAccessPath key_data_path;
1328
1
            key_data_path.__set_path({_key_iterator->column_name()});
1329
1
            key_path.__set_data_access_path(key_data_path);
1330
1
            key_all_access_paths.emplace_back(std::move(key_path));
1331
            // For value: pass the full sub-path so qualifiers like OFFSET propagate.
1332
1
            paths.data_access_path.path[0] = _val_iterator->column_name();
1333
1
            val_all_access_paths.emplace_back(paths);
1334
1
        } else if (paths.data_access_path.path[0] == ACCESS_MAP_KEYS) {
1335
1
            paths.data_access_path.path[0] = _key_iterator->column_name();
1336
1
            key_all_access_paths.emplace_back(paths);
1337
1
        } else if (paths.data_access_path.path[0] == ACCESS_MAP_VALUES) {
1338
0
            paths.data_access_path.path[0] = _val_iterator->column_name();
1339
0
            val_all_access_paths.emplace_back(paths);
1340
0
        }
1341
2
    }
1342
2
    const auto need_read_keys = !key_all_access_paths.empty();
1343
2
    const auto need_read_values = !val_all_access_paths.empty();
1344
1345
2
    for (auto paths : sub_predicate_access_paths) {
1346
0
        if (paths.data_access_path.path[0] == ACCESS_ALL) {
1347
            // Same logic as above: key needs full data, value gets the sub-path.
1348
0
            TColumnAccessPath key_path;
1349
0
            key_path.__set_type(paths.type);
1350
0
            TDataAccessPath key_data_path;
1351
0
            key_data_path.__set_path({_key_iterator->column_name()});
1352
0
            key_path.__set_data_access_path(key_data_path);
1353
0
            key_predicate_access_paths.emplace_back(std::move(key_path));
1354
0
            paths.data_access_path.path[0] = _val_iterator->column_name();
1355
0
            val_predicate_access_paths.emplace_back(paths);
1356
0
        } else if (paths.data_access_path.path[0] == ACCESS_MAP_KEYS) {
1357
0
            paths.data_access_path.path[0] = _key_iterator->column_name();
1358
0
            key_predicate_access_paths.emplace_back(paths);
1359
0
        } else if (paths.data_access_path.path[0] == ACCESS_MAP_VALUES) {
1360
0
            paths.data_access_path.path[0] = _val_iterator->column_name();
1361
0
            val_predicate_access_paths.emplace_back(paths);
1362
0
        }
1363
0
    }
1364
1365
2
    if (need_read_keys) {
1366
2
        _key_iterator->set_reading_flag(ReadingFlag::NEED_TO_READ);
1367
2
        RETURN_IF_ERROR(
1368
2
                _key_iterator->set_access_paths(key_all_access_paths, key_predicate_access_paths));
1369
2
    } else {
1370
0
        _key_iterator->set_reading_flag(ReadingFlag::SKIP_READING);
1371
0
        DLOG(INFO) << "Map column iterator set key column to SKIP_READING";
1372
0
    }
1373
1374
2
    if (need_read_values) {
1375
1
        _val_iterator->set_reading_flag(ReadingFlag::NEED_TO_READ);
1376
1
        RETURN_IF_ERROR(
1377
1
                _val_iterator->set_access_paths(val_all_access_paths, val_predicate_access_paths));
1378
1
    } else {
1379
1
        _val_iterator->set_reading_flag(ReadingFlag::SKIP_READING);
1380
1
        DLOG(INFO) << "Map column iterator set value column to SKIP_READING";
1381
1
    }
1382
2
    return Status::OK();
1383
2
}
1384
1385
////////////////////////////////////////////////////////////////////////////////
1386
1387
StructFileColumnIterator::StructFileColumnIterator(
1388
        std::shared_ptr<ColumnReader> reader, ColumnIteratorUPtr null_iterator,
1389
        std::vector<ColumnIteratorUPtr>&& sub_column_iterators)
1390
4
        : _struct_reader(reader), _sub_column_iterators(std::move(sub_column_iterators)) {
1391
4
    if (_struct_reader->is_nullable()) {
1392
0
        _null_iterator = std::move(null_iterator);
1393
0
    }
1394
4
}
1395
1396
0
Status StructFileColumnIterator::init(const ColumnIteratorOptions& opts) {
1397
0
    if (_reading_flag == ReadingFlag::SKIP_READING) {
1398
0
        DLOG(INFO) << "Struct column iterator column " << _column_name << " skip reading.";
1399
0
        return Status::OK();
1400
0
    }
1401
1402
0
    for (auto& column_iterator : _sub_column_iterators) {
1403
0
        RETURN_IF_ERROR(column_iterator->init(opts));
1404
0
    }
1405
0
    if (_struct_reader->is_nullable()) {
1406
0
        RETURN_IF_ERROR(_null_iterator->init(opts));
1407
0
    }
1408
0
    return Status::OK();
1409
0
}
1410
1411
0
Status StructFileColumnIterator::next_batch(size_t* n, MutableColumnPtr& dst, bool* has_null) {
1412
0
    if (_reading_flag == ReadingFlag::SKIP_READING) {
1413
0
        DLOG(INFO) << "Struct column iterator column " << _column_name << " skip reading.";
1414
0
        dst->insert_many_defaults(*n);
1415
0
        return Status::OK();
1416
0
    }
1417
1418
0
    if (read_null_map_only()) {
1419
        // NULL_MAP_ONLY mode: read null map, fill nested ColumnStruct with empty defaults
1420
0
        DORIS_CHECK(is_column_nullable(*dst));
1421
0
        auto& nullable_col = assert_cast<ColumnNullable&>(*dst);
1422
0
        auto null_map_ptr = nullable_col.get_null_map_column_ptr();
1423
0
        size_t num_read = *n;
1424
0
        if (_null_iterator) {
1425
0
            bool null_signs_has_null = false;
1426
0
            MutableColumnPtr null_map_column = std::move(null_map_ptr);
1427
0
            RETURN_IF_ERROR(
1428
0
                    _null_iterator->next_batch(&num_read, null_map_column, &null_signs_has_null));
1429
0
        } else {
1430
            // schema-change: column became nullable but old segment has no null data
1431
0
            null_map_ptr->insert_many_vals(0, num_read);
1432
0
        }
1433
0
        DCHECK(num_read == *n);
1434
        // fill nested ColumnStruct with defaults to maintain consistent column sizes
1435
0
        auto& column_struct = assert_cast<ColumnStruct&, TypeCheckOnRelease::DISABLE>(
1436
0
                nullable_col.get_nested_column());
1437
0
        column_struct.insert_many_defaults(num_read);
1438
0
        *has_null = true;
1439
0
        return Status::OK();
1440
0
    }
1441
1442
0
    auto& column_struct = assert_cast<ColumnStruct&, TypeCheckOnRelease::DISABLE>(
1443
0
            is_column_nullable(*dst) ? static_cast<ColumnNullable&>(*dst).get_nested_column()
1444
0
                                     : *dst);
1445
0
    for (size_t i = 0; i < column_struct.tuple_size(); i++) {
1446
0
        size_t num_read = *n;
1447
0
        auto sub_column_ptr = IColumn::mutate(std::move(column_struct.get_column_ptr(i)));
1448
0
        Defer defer_sub_column {
1449
0
                [&] { column_struct.get_column_ptr(i) = std::move(sub_column_ptr); }};
1450
0
        bool column_has_null = false;
1451
0
        RETURN_IF_ERROR(
1452
0
                _sub_column_iterators[i]->next_batch(&num_read, sub_column_ptr, &column_has_null));
1453
0
        DCHECK(num_read == *n);
1454
0
    }
1455
1456
0
    if (is_column_nullable(*dst)) {
1457
0
        size_t num_read = *n;
1458
0
        auto null_map_ptr = static_cast<ColumnNullable&>(*dst).get_null_map_column_ptr();
1459
        // in not-null to null linked-schemachange mode,
1460
        // actually we do not change dat data include meta in footer,
1461
        // so may dst from changed meta which is nullable but old data is not nullable,
1462
        // if so, we should set null_map to all null by default
1463
0
        if (_null_iterator) {
1464
0
            bool null_signs_has_null = false;
1465
0
            MutableColumnPtr null_map_column = std::move(null_map_ptr);
1466
0
            RETURN_IF_ERROR(
1467
0
                    _null_iterator->next_batch(&num_read, null_map_column, &null_signs_has_null));
1468
0
        } else {
1469
0
            null_map_ptr->insert_many_vals(0, num_read);
1470
0
        }
1471
0
        DCHECK(num_read == *n);
1472
0
    }
1473
1474
0
    return Status::OK();
1475
0
}
1476
1477
0
Status StructFileColumnIterator::seek_to_ordinal(ordinal_t ord) {
1478
0
    if (_reading_flag == ReadingFlag::SKIP_READING) {
1479
0
        DLOG(INFO) << "Struct column iterator column " << _column_name << " skip reading.";
1480
0
        return Status::OK();
1481
0
    }
1482
1483
0
    if (read_null_map_only()) {
1484
        // In NULL_MAP_ONLY mode, only seek the null iterator; skip all sub-column iterators
1485
0
        if (_struct_reader->is_nullable() && _null_iterator) {
1486
0
            RETURN_IF_ERROR(_null_iterator->seek_to_ordinal(ord));
1487
0
        }
1488
0
        return Status::OK();
1489
0
    }
1490
1491
0
    for (auto& column_iterator : _sub_column_iterators) {
1492
0
        RETURN_IF_ERROR(column_iterator->seek_to_ordinal(ord));
1493
0
    }
1494
0
    if (_struct_reader->is_nullable()) {
1495
0
        RETURN_IF_ERROR(_null_iterator->seek_to_ordinal(ord));
1496
0
    }
1497
0
    return Status::OK();
1498
0
}
1499
1500
0
Status StructFileColumnIterator::init_prefetcher(const SegmentPrefetchParams& params) {
1501
0
    for (auto& column_iterator : _sub_column_iterators) {
1502
0
        RETURN_IF_ERROR(column_iterator->init_prefetcher(params));
1503
0
    }
1504
0
    if (_struct_reader->is_nullable()) {
1505
0
        RETURN_IF_ERROR(_null_iterator->init_prefetcher(params));
1506
0
    }
1507
0
    return Status::OK();
1508
0
}
1509
1510
void StructFileColumnIterator::collect_prefetchers(
1511
        std::map<PrefetcherInitMethod, std::vector<SegmentPrefetcher*>>& prefetchers,
1512
0
        PrefetcherInitMethod init_method) {
1513
0
    for (auto& column_iterator : _sub_column_iterators) {
1514
0
        column_iterator->collect_prefetchers(prefetchers, init_method);
1515
0
    }
1516
0
    if (_struct_reader->is_nullable()) {
1517
0
        _null_iterator->collect_prefetchers(prefetchers, init_method);
1518
0
    }
1519
0
}
1520
1521
Status StructFileColumnIterator::read_by_rowids(const rowid_t* rowids, const size_t count,
1522
0
                                                MutableColumnPtr& dst) {
1523
0
    if (_reading_flag == ReadingFlag::SKIP_READING) {
1524
0
        DLOG(INFO) << "Struct column iterator column " << _column_name << " skip reading.";
1525
0
        dst->insert_many_defaults(count);
1526
0
        return Status::OK();
1527
0
    }
1528
1529
0
    if (count == 0) {
1530
0
        return Status::OK();
1531
0
    }
1532
1533
0
    size_t this_run = 1;
1534
0
    auto start_idx = rowids[0];
1535
0
    auto last_idx = rowids[0];
1536
0
    for (size_t i = 1; i < count; ++i) {
1537
0
        if (last_idx == rowids[i] - 1) {
1538
0
            last_idx = rowids[i];
1539
0
            this_run++;
1540
0
            continue;
1541
0
        }
1542
0
        RETURN_IF_ERROR(seek_to_ordinal(start_idx));
1543
0
        size_t num_read = this_run;
1544
0
        RETURN_IF_ERROR(next_batch(&num_read, dst));
1545
0
        DCHECK_EQ(num_read, this_run);
1546
1547
0
        start_idx = rowids[i];
1548
0
        last_idx = rowids[i];
1549
0
        this_run = 1;
1550
0
    }
1551
1552
0
    RETURN_IF_ERROR(seek_to_ordinal(start_idx));
1553
0
    size_t num_read = this_run;
1554
0
    RETURN_IF_ERROR(next_batch(&num_read, dst));
1555
0
    DCHECK_EQ(num_read, this_run);
1556
0
    return Status::OK();
1557
0
}
1558
1559
1
void StructFileColumnIterator::set_need_to_read() {
1560
1
    set_reading_flag(ReadingFlag::NEED_TO_READ);
1561
2
    for (auto& sub_iterator : _sub_column_iterators) {
1562
2
        sub_iterator->set_need_to_read();
1563
2
    }
1564
1
}
1565
1566
0
void StructFileColumnIterator::remove_pruned_sub_iterators() {
1567
0
    for (auto it = _sub_column_iterators.begin(); it != _sub_column_iterators.end();) {
1568
0
        auto& sub_iterator = *it;
1569
0
        if (sub_iterator->reading_flag() == ReadingFlag::SKIP_READING) {
1570
0
            DLOG(INFO) << "Struct column iterator remove pruned sub-column "
1571
0
                       << sub_iterator->column_name();
1572
0
            it = _sub_column_iterators.erase(it);
1573
0
        } else {
1574
0
            sub_iterator->remove_pruned_sub_iterators();
1575
0
            ++it;
1576
0
        }
1577
0
    }
1578
0
}
1579
1580
Status StructFileColumnIterator::set_access_paths(
1581
        const TColumnAccessPaths& all_access_paths,
1582
6
        const TColumnAccessPaths& predicate_access_paths) {
1583
6
    if (all_access_paths.empty()) {
1584
1
        return Status::OK();
1585
1
    }
1586
1587
5
    if (!predicate_access_paths.empty()) {
1588
4
        set_reading_flag(ReadingFlag::READING_FOR_PREDICATE);
1589
4
        DLOG(INFO) << "Struct column iterator set sub-column " << _column_name
1590
4
                   << " to READING_FOR_PREDICATE";
1591
4
    }
1592
5
    auto sub_all_access_paths = DORIS_TRY(_get_sub_access_paths(all_access_paths));
1593
3
    auto sub_predicate_access_paths = DORIS_TRY(_get_sub_access_paths(predicate_access_paths));
1594
1595
    // Check for NULL_MAP_ONLY mode: only read null map, skip all sub-columns
1596
3
    _check_and_set_meta_read_mode(sub_all_access_paths);
1597
3
    if (read_null_map_only()) {
1598
0
        for (auto& sub_iterator : _sub_column_iterators) {
1599
0
            sub_iterator->set_reading_flag(ReadingFlag::SKIP_READING);
1600
0
        }
1601
0
        DLOG(INFO) << "Struct column iterator set column " << _column_name
1602
0
                   << " to NULL_MAP_ONLY reading mode, all sub-columns set to SKIP_READING";
1603
0
        return Status::OK();
1604
0
    }
1605
1606
3
    const auto no_sub_column_to_skip = sub_all_access_paths.empty();
1607
3
    const auto no_predicate_sub_column = sub_predicate_access_paths.empty();
1608
1609
6
    for (auto& sub_iterator : _sub_column_iterators) {
1610
6
        const auto name = sub_iterator->column_name();
1611
6
        bool need_to_read = no_sub_column_to_skip;
1612
6
        TColumnAccessPaths sub_all_access_paths_of_this;
1613
6
        if (!need_to_read) {
1614
4
            for (const auto& paths : sub_all_access_paths) {
1615
4
                if (paths.data_access_path.path[0] == name) {
1616
2
                    sub_all_access_paths_of_this.emplace_back(paths);
1617
2
                }
1618
4
            }
1619
4
            need_to_read = !sub_all_access_paths_of_this.empty();
1620
4
        }
1621
1622
6
        if (!need_to_read) {
1623
2
            sub_iterator->set_reading_flag(ReadingFlag::SKIP_READING);
1624
2
            DLOG(INFO) << "Struct column iterator set sub-column " << name << " to SKIP_READING";
1625
2
            continue;
1626
2
        }
1627
4
        set_reading_flag(ReadingFlag::NEED_TO_READ);
1628
4
        sub_iterator->set_reading_flag(ReadingFlag::NEED_TO_READ);
1629
1630
4
        TColumnAccessPaths sub_predicate_access_paths_of_this;
1631
1632
4
        if (!no_predicate_sub_column) {
1633
3
            for (const auto& paths : sub_predicate_access_paths) {
1634
3
                if (StringCaseEqual()(paths.data_access_path.path[0], name)) {
1635
2
                    sub_predicate_access_paths_of_this.emplace_back(paths);
1636
2
                }
1637
3
            }
1638
3
        }
1639
1640
4
        RETURN_IF_ERROR(sub_iterator->set_access_paths(sub_all_access_paths_of_this,
1641
4
                                                       sub_predicate_access_paths_of_this));
1642
4
    }
1643
3
    return Status::OK();
1644
3
}
1645
1646
////////////////////////////////////////////////////////////////////////////////
1647
307
Status OffsetFileColumnIterator::init(const ColumnIteratorOptions& opts) {
1648
307
    RETURN_IF_ERROR(_offset_iterator->init(opts));
1649
    // allocate peek tmp column once
1650
307
    _peek_tmp_col = ColumnOffset64::create();
1651
307
    return Status::OK();
1652
307
}
1653
1654
306
Status OffsetFileColumnIterator::next_batch(size_t* n, MutableColumnPtr& dst, bool* has_null) {
1655
306
    RETURN_IF_ERROR(_offset_iterator->next_batch(n, dst, has_null));
1656
306
    return Status::OK();
1657
306
}
1658
1659
604
Status OffsetFileColumnIterator::_peek_one_offset(ordinal_t* offset) {
1660
604
    if (_offset_iterator->get_current_page()->has_remaining()) {
1661
301
        PageDecoder* offset_page_decoder = _offset_iterator->get_current_page()->data_decoder.get();
1662
301
        size_t n = 1;
1663
301
        _peek_tmp_col->clear();
1664
301
        RETURN_IF_ERROR(offset_page_decoder->peek_next_batch(&n, _peek_tmp_col)); // not null
1665
301
        DCHECK(_peek_tmp_col->size() == 1);
1666
301
        *offset =
1667
301
                assert_cast<const ColumnOffset64*, TypeCheckOnRelease::DISABLE>(_peek_tmp_col.get())
1668
301
                        ->get_element(0);
1669
303
    } else {
1670
303
        *offset = _offset_iterator->get_current_page()->next_array_item_ordinal;
1671
303
    }
1672
604
    return Status::OK();
1673
604
}
1674
1675
0
Status OffsetFileColumnIterator::init_prefetcher(const SegmentPrefetchParams& params) {
1676
0
    return _offset_iterator->init_prefetcher(params);
1677
0
}
1678
1679
void OffsetFileColumnIterator::collect_prefetchers(
1680
        std::map<PrefetcherInitMethod, std::vector<SegmentPrefetcher*>>& prefetchers,
1681
0
        PrefetcherInitMethod init_method) {
1682
0
    _offset_iterator->collect_prefetchers(prefetchers, init_method);
1683
0
}
1684
1685
/**
1686
 *  first_storage_offset read from page should smaller than next_storage_offset which here call _peek_one_offset from page,
1687
    and first_column_offset is keep in memory data which is different dimension with (first_storage_offset and next_storage_offset)
1688
     eg. step1. read page: first_storage_offset = 16382
1689
         step2. read page below with _peek_one_offset(&last_offset): last_offset = 16387
1690
         step3. first_offset = 126 which is calculate in column offsets
1691
         for loop column offsets element in size
1692
            we can calculate from first_storage_offset to next_storage_offset one by one to fill with offsets_data in memory column offsets
1693
 * @param start
1694
 * @param column_offsets
1695
 * @return
1696
 */
1697
Status OffsetFileColumnIterator::_calculate_offsets(ssize_t start,
1698
294
                                                    ColumnArray::ColumnOffsets& column_offsets) {
1699
294
    ordinal_t next_storage_offset = 0;
1700
294
    RETURN_IF_ERROR(_peek_one_offset(&next_storage_offset));
1701
1702
    // calculate real offsets
1703
294
    auto& offsets_data = column_offsets.get_data();
1704
294
    ordinal_t first_column_offset = offsets_data[start - 1]; // -1 is valid
1705
294
    ordinal_t first_storage_offset = offsets_data[start];
1706
294
    DCHECK(next_storage_offset >= first_storage_offset);
1707
93.1k
    for (ssize_t i = start; i < offsets_data.size() - 1; ++i) {
1708
92.8k
        offsets_data[i] = first_column_offset + (offsets_data[i + 1] - first_storage_offset);
1709
92.8k
    }
1710
    // last offset
1711
294
    offsets_data[offsets_data.size() - 1] =
1712
294
            first_column_offset + (next_storage_offset - first_storage_offset);
1713
294
    return Status::OK();
1714
294
}
1715
1716
////////////////////////////////////////////////////////////////////////////////
1717
ArrayFileColumnIterator::ArrayFileColumnIterator(std::shared_ptr<ColumnReader> reader,
1718
                                                 OffsetFileColumnIteratorUPtr offset_reader,
1719
                                                 ColumnIteratorUPtr item_iterator,
1720
                                                 ColumnIteratorUPtr null_iterator)
1721
32
        : _array_reader(reader),
1722
32
          _offset_iterator(std::move(offset_reader)),
1723
32
          _item_iterator(std::move(item_iterator)) {
1724
32
    if (_array_reader->is_nullable()) {
1725
29
        _null_iterator = std::move(null_iterator);
1726
29
    }
1727
32
}
1728
1729
31
Status ArrayFileColumnIterator::init(const ColumnIteratorOptions& opts) {
1730
31
    if (_reading_flag == ReadingFlag::SKIP_READING) {
1731
0
        DLOG(INFO) << "Array column iterator column " << _column_name << " skip readking.";
1732
0
        return Status::OK();
1733
0
    }
1734
1735
31
    RETURN_IF_ERROR(_offset_iterator->init(opts));
1736
31
    RETURN_IF_ERROR(_item_iterator->init(opts));
1737
31
    if (_array_reader->is_nullable()) {
1738
29
        RETURN_IF_ERROR(_null_iterator->init(opts));
1739
29
    }
1740
31
    return Status::OK();
1741
31
}
1742
1743
32
Status ArrayFileColumnIterator::_seek_by_offsets(ordinal_t ord) {
1744
32
    if (read_offset_only()) {
1745
        // In OFFSET_ONLY mode, item iterator is SKIP_READING, no need to seek it
1746
0
        return Status::OK();
1747
0
    }
1748
    // using offsets info
1749
32
    ordinal_t offset = 0;
1750
32
    RETURN_IF_ERROR(_offset_iterator->_peek_one_offset(&offset));
1751
32
    RETURN_IF_ERROR(_item_iterator->seek_to_ordinal(offset));
1752
32
    return Status::OK();
1753
32
}
1754
1755
32
Status ArrayFileColumnIterator::seek_to_ordinal(ordinal_t ord) {
1756
32
    if (_reading_flag == ReadingFlag::SKIP_READING) {
1757
0
        DLOG(INFO) << "Array column iterator column " << _column_name << " skip reading.";
1758
0
        return Status::OK();
1759
0
    }
1760
1761
32
    if (read_null_map_only()) {
1762
        // In NULL_MAP_ONLY mode, only seek the null iterator; skip offset and item iterators
1763
0
        if (_array_reader->is_nullable() && _null_iterator) {
1764
0
            RETURN_IF_ERROR(_null_iterator->seek_to_ordinal(ord));
1765
0
        }
1766
0
        return Status::OK();
1767
0
    }
1768
1769
32
    RETURN_IF_ERROR(_offset_iterator->seek_to_ordinal(ord));
1770
32
    if (_array_reader->is_nullable()) {
1771
30
        RETURN_IF_ERROR(_null_iterator->seek_to_ordinal(ord));
1772
30
    }
1773
32
    return _seek_by_offsets(ord);
1774
32
}
1775
1776
30
Status ArrayFileColumnIterator::next_batch(size_t* n, MutableColumnPtr& dst, bool* has_null) {
1777
30
    if (_reading_flag == ReadingFlag::SKIP_READING) {
1778
0
        DLOG(INFO) << "Array column iterator column " << _column_name << " skip reading.";
1779
0
        dst->insert_many_defaults(*n);
1780
0
        return Status::OK();
1781
0
    }
1782
1783
30
    if (read_null_map_only()) {
1784
        // NULL_MAP_ONLY mode: read null map, fill nested ColumnArray with empty defaults
1785
0
        DORIS_CHECK(is_column_nullable(*dst));
1786
0
        auto& nullable_col = assert_cast<ColumnNullable&>(*dst);
1787
0
        auto null_map_ptr = nullable_col.get_null_map_column_ptr();
1788
0
        size_t num_read = *n;
1789
0
        if (_null_iterator) {
1790
0
            bool null_signs_has_null = false;
1791
0
            MutableColumnPtr null_map_column = std::move(null_map_ptr);
1792
0
            RETURN_IF_ERROR(
1793
0
                    _null_iterator->next_batch(&num_read, null_map_column, &null_signs_has_null));
1794
0
        } else {
1795
            // schema-change: column became nullable but old segment has no null data
1796
0
            null_map_ptr->insert_many_vals(0, num_read);
1797
0
        }
1798
0
        DCHECK(num_read == *n);
1799
        // fill nested ColumnArray with empty (zero-length) arrays
1800
0
        auto& column_array = assert_cast<ColumnArray&, TypeCheckOnRelease::DISABLE>(
1801
0
                nullable_col.get_nested_column());
1802
0
        column_array.insert_many_defaults(num_read);
1803
0
        *has_null = true;
1804
0
        return Status::OK();
1805
0
    }
1806
1807
30
    auto& column_array = assert_cast<ColumnArray&, TypeCheckOnRelease::DISABLE>(
1808
30
            is_column_nullable(*dst) ? static_cast<ColumnNullable&>(*dst).get_nested_column()
1809
30
                                     : *dst);
1810
1811
30
    bool offsets_has_null = false;
1812
30
    auto column_offsets_ptr = std::move(*column_array.get_offsets_ptr()).mutate();
1813
30
    Defer defer_offsets {[&] {
1814
30
        auto typed_column_offsets_ptr = ColumnArray::ColumnOffsets::cast_to_column_mutptr(
1815
30
                assert_cast<ColumnArray::ColumnOffsets*, TypeCheckOnRelease::DISABLE>(
1816
30
                        column_offsets_ptr.get()));
1817
30
        column_offsets_ptr = nullptr;
1818
30
        column_array.get_offsets_ptr() = std::move(typed_column_offsets_ptr);
1819
30
    }};
1820
30
    ssize_t start = column_offsets_ptr->size();
1821
30
    RETURN_IF_ERROR(_offset_iterator->next_batch(n, column_offsets_ptr, &offsets_has_null));
1822
30
    if (*n == 0) {
1823
0
        return Status::OK();
1824
0
    }
1825
30
    auto& column_offsets = static_cast<ColumnArray::ColumnOffsets&>(*column_offsets_ptr);
1826
30
    RETURN_IF_ERROR(_offset_iterator->_calculate_offsets(start, column_offsets));
1827
30
    size_t num_items =
1828
30
            column_offsets.get_data().back() - column_offsets.get_data()[start - 1]; // -1 is valid
1829
30
    if (num_items > 0) {
1830
28
        auto column_items_ptr = IColumn::mutate(std::move(column_array.get_data_ptr()));
1831
28
        Defer defer_items {[&] { column_array.get_data_ptr() = std::move(column_items_ptr); }};
1832
28
        if (read_offset_only()) {
1833
            // OFFSET_ONLY mode: skip reading actual item data, fill with defaults
1834
0
            column_items_ptr->insert_many_defaults(num_items);
1835
28
        } else {
1836
28
            size_t num_read = num_items;
1837
28
            bool items_has_null = false;
1838
28
            RETURN_IF_ERROR(
1839
28
                    _item_iterator->next_batch(&num_read, column_items_ptr, &items_has_null));
1840
28
            DCHECK(num_read == num_items);
1841
28
        }
1842
28
    }
1843
1844
30
    if (is_column_nullable(*dst)) {
1845
28
        auto null_map_ptr = static_cast<ColumnNullable&>(*dst).get_null_map_column_ptr();
1846
28
        size_t num_read = *n;
1847
        // in not-null to null linked-schemachange mode,
1848
        // actually we do not change dat data include meta in footer,
1849
        // so may dst from changed meta which is nullable but old data is not nullable,
1850
        // if so, we should set null_map to all null by default
1851
28
        if (_null_iterator) {
1852
28
            bool null_signs_has_null = false;
1853
28
            MutableColumnPtr null_map_column = std::move(null_map_ptr);
1854
28
            RETURN_IF_ERROR(
1855
28
                    _null_iterator->next_batch(&num_read, null_map_column, &null_signs_has_null));
1856
28
        } else {
1857
0
            null_map_ptr->insert_many_vals(0, num_read);
1858
0
        }
1859
28
        DCHECK(num_read == *n);
1860
28
    }
1861
1862
30
    return Status::OK();
1863
30
}
1864
1865
0
Status ArrayFileColumnIterator::init_prefetcher(const SegmentPrefetchParams& params) {
1866
0
    RETURN_IF_ERROR(_offset_iterator->init_prefetcher(params));
1867
0
    RETURN_IF_ERROR(_item_iterator->init_prefetcher(params));
1868
0
    if (_array_reader->is_nullable()) {
1869
0
        RETURN_IF_ERROR(_null_iterator->init_prefetcher(params));
1870
0
    }
1871
0
    return Status::OK();
1872
0
}
1873
1874
void ArrayFileColumnIterator::collect_prefetchers(
1875
        std::map<PrefetcherInitMethod, std::vector<SegmentPrefetcher*>>& prefetchers,
1876
0
        PrefetcherInitMethod init_method) {
1877
0
    _offset_iterator->collect_prefetchers(prefetchers, init_method);
1878
    // the actual data pages to read of item column depends on the read result of offset column,
1879
    // so we can't init prefetch blocks according to rowids, just prefetch all data blocks here.
1880
0
    _item_iterator->collect_prefetchers(prefetchers, PrefetcherInitMethod::ALL_DATA_BLOCKS);
1881
0
    if (_array_reader->is_nullable()) {
1882
0
        _null_iterator->collect_prefetchers(prefetchers, init_method);
1883
0
    }
1884
0
}
1885
1886
Status ArrayFileColumnIterator::read_by_rowids(const rowid_t* rowids, const size_t count,
1887
11
                                               MutableColumnPtr& dst) {
1888
11
    if (_reading_flag == ReadingFlag::SKIP_READING) {
1889
0
        DLOG(INFO) << "Array column iterator column " << _column_name << " skip reading.";
1890
0
        dst->insert_many_defaults(count);
1891
0
        return Status::OK();
1892
0
    }
1893
1894
23
    for (size_t i = 0; i < count; ++i) {
1895
        // TODO(cambyszju): now read array one by one, need optimize later
1896
12
        RETURN_IF_ERROR(seek_to_ordinal(rowids[i]));
1897
12
        size_t num_read = 1;
1898
12
        RETURN_IF_ERROR(next_batch(&num_read, dst));
1899
12
    }
1900
11
    return Status::OK();
1901
11
}
1902
1903
0
void ArrayFileColumnIterator::set_need_to_read() {
1904
0
    set_reading_flag(ReadingFlag::NEED_TO_READ);
1905
0
    _item_iterator->set_need_to_read();
1906
0
}
1907
1908
0
void ArrayFileColumnIterator::remove_pruned_sub_iterators() {
1909
0
    _item_iterator->remove_pruned_sub_iterators();
1910
0
}
1911
1912
Status ArrayFileColumnIterator::set_access_paths(const TColumnAccessPaths& all_access_paths,
1913
1
                                                 const TColumnAccessPaths& predicate_access_paths) {
1914
1
    if (all_access_paths.empty()) {
1915
0
        return Status::OK();
1916
0
    }
1917
1918
1
    if (!predicate_access_paths.empty()) {
1919
0
        set_reading_flag(ReadingFlag::READING_FOR_PREDICATE);
1920
0
        DLOG(INFO) << "Array column iterator set sub-column " << _column_name
1921
0
                   << " to READING_FOR_PREDICATE";
1922
0
    }
1923
1924
1
    auto sub_all_access_paths = DORIS_TRY(_get_sub_access_paths(all_access_paths));
1925
1
    auto sub_predicate_access_paths = DORIS_TRY(_get_sub_access_paths(predicate_access_paths));
1926
1927
    // Check for meta-only modes (OFFSET_ONLY or NULL_MAP_ONLY)
1928
1
    _check_and_set_meta_read_mode(sub_all_access_paths);
1929
1
    if (read_offset_only()) {
1930
0
        _item_iterator->set_reading_flag(ReadingFlag::SKIP_READING);
1931
0
        DLOG(INFO) << "Array column iterator set column " << _column_name
1932
0
                   << " to OFFSET_ONLY reading mode, item column set to SKIP_READING";
1933
0
        return Status::OK();
1934
0
    }
1935
1
    if (read_null_map_only()) {
1936
0
        _item_iterator->set_reading_flag(ReadingFlag::SKIP_READING);
1937
0
        DLOG(INFO) << "Array column iterator set column " << _column_name
1938
0
                   << " to NULL_MAP_ONLY reading mode, item column set to SKIP_READING";
1939
0
        return Status::OK();
1940
0
    }
1941
1942
1
    const auto no_sub_column_to_skip = sub_all_access_paths.empty();
1943
1
    const auto no_predicate_sub_column = sub_predicate_access_paths.empty();
1944
1945
1
    if (!no_sub_column_to_skip) {
1946
1
        for (auto& path : sub_all_access_paths) {
1947
1
            if (path.data_access_path.path[0] == ACCESS_ALL) {
1948
1
                path.data_access_path.path[0] = _item_iterator->column_name();
1949
1
            }
1950
1
        }
1951
1
    }
1952
1953
1
    if (!no_predicate_sub_column) {
1954
0
        for (auto& path : sub_predicate_access_paths) {
1955
0
            if (path.data_access_path.path[0] == ACCESS_ALL) {
1956
0
                path.data_access_path.path[0] = _item_iterator->column_name();
1957
0
            }
1958
0
        }
1959
0
    }
1960
1961
1
    if (!no_sub_column_to_skip || !no_predicate_sub_column) {
1962
1
        _item_iterator->set_reading_flag(ReadingFlag::NEED_TO_READ);
1963
1
        RETURN_IF_ERROR(
1964
1
                _item_iterator->set_access_paths(sub_all_access_paths, sub_predicate_access_paths));
1965
1
    }
1966
1
    return Status::OK();
1967
1
}
1968
1969
////////////////////////////////////////////////////////////////////////////////
1970
// StringFileColumnIterator implementation
1971
////////////////////////////////////////////////////////////////////////////////
1972
1973
StringFileColumnIterator::StringFileColumnIterator(std::shared_ptr<ColumnReader> reader)
1974
2.91k
        : FileColumnIterator(std::move(reader)) {}
1975
1976
2.90k
Status StringFileColumnIterator::init(const ColumnIteratorOptions& opts) {
1977
2.90k
    if (read_offset_only()) {
1978
        // Propagate only_read_offsets to the FileColumnIterator's options
1979
0
        auto modified_opts = opts;
1980
0
        modified_opts.only_read_offsets = true;
1981
0
        return FileColumnIterator::init(modified_opts);
1982
0
    }
1983
2.90k
    return FileColumnIterator::init(opts);
1984
2.90k
}
1985
1986
Status StringFileColumnIterator::set_access_paths(
1987
        const TColumnAccessPaths& all_access_paths,
1988
2
        const TColumnAccessPaths& predicate_access_paths) {
1989
2
    if (all_access_paths.empty()) {
1990
0
        return Status::OK();
1991
0
    }
1992
1993
2
    if (!predicate_access_paths.empty()) {
1994
0
        set_reading_flag(ReadingFlag::READING_FOR_PREDICATE);
1995
0
    }
1996
1997
    // Strip the column name from path[0] before checking for meta-only modes.
1998
    // Raw paths look like ["col_name", "OFFSET"] or ["col_name", "NULL"].
1999
2
    auto sub_all_access_paths = DORIS_TRY(_get_sub_access_paths(all_access_paths));
2000
2
    _check_and_set_meta_read_mode(sub_all_access_paths);
2001
    // OFFSET_ONLY mode is fundamentally incompatible with CHAR columns:
2002
    // CHAR is stored padded to its declared length (see
2003
    // OlapColumnDataConvertorChar::clone_and_padding), so the per-row length
2004
    // recorded in dict word info / page headers is always the padded length
2005
    // (e.g. 25 for CHAR(25)) — never the logical length expected by length().
2006
    // Recovering the logical length requires scanning the chars buffer with
2007
    // strnlen() (shrink_padding_chars), which OFFSET_ONLY by definition skips.
2008
    // There is no partial-benefit path: any optimization that still produces
2009
    // the correct length() result must read the chars buffer in full.
2010
    //
2011
    // FE (NestedColumnPruning) already filters CHAR slots out of the
2012
    // OFFSET-only access plan, so reaching this branch means an FE/BE
2013
    // contract violation. Fail loudly instead of silently falling back.
2014
2
    if (read_offset_only() && get_reader() != nullptr &&
2015
2
        get_reader()->get_meta_type() == FieldType::OLAP_FIELD_TYPE_CHAR) {
2016
0
        return Status::InternalError(
2017
0
                "OFFSET_ONLY access path is not supported on CHAR column '{}': CHAR is stored "
2018
0
                "padded so the per-row length information available without reading the chars "
2019
0
                "buffer is always the padded length, not the logical length. The FE planner "
2020
0
                "must not emit an OFFSET access path for CHAR columns.",
2021
0
                _column_name);
2022
0
    }
2023
2
    if (read_offset_only()) {
2024
1
        DLOG(INFO) << "String column iterator set column " << _column_name
2025
1
                   << " to OFFSET_ONLY reading mode";
2026
1
    } else if (read_null_map_only()) {
2027
0
        DLOG(INFO) << "String column iterator set column " << _column_name
2028
0
                   << " to NULL_MAP_ONLY reading mode";
2029
0
    }
2030
2031
2
    return Status::OK();
2032
2
}
2033
2034
////////////////////////////////////////////////////////////////////////////////
2035
2036
8.64k
FileColumnIterator::FileColumnIterator(std::shared_ptr<ColumnReader> reader) : _reader(reader) {}
2037
2038
8
void ColumnIterator::_check_and_set_meta_read_mode(const TColumnAccessPaths& sub_all_access_paths) {
2039
8
    for (const auto& path : sub_all_access_paths) {
2040
6
        if (!path.data_access_path.path.empty()) {
2041
6
            if (StringCaseEqual()(path.data_access_path.path[0], ACCESS_OFFSET)) {
2042
1
                _read_mode = ReadMode::OFFSET_ONLY;
2043
1
                return;
2044
5
            } else if (StringCaseEqual()(path.data_access_path.path[0], ACCESS_NULL)) {
2045
0
                _read_mode = ReadMode::NULL_MAP_ONLY;
2046
0
                return;
2047
0
            }
2048
6
        }
2049
6
    }
2050
7
    _read_mode = ReadMode::DEFAULT;
2051
7
}
2052
2053
8.59k
Status FileColumnIterator::init(const ColumnIteratorOptions& opts) {
2054
8.59k
    if (_reading_flag == ReadingFlag::SKIP_READING) {
2055
0
        DLOG(INFO) << "File column iterator column " << _column_name << " skip reading.";
2056
0
        return Status::OK();
2057
0
    }
2058
2059
8.59k
    _opts = opts;
2060
8.59k
    if (!_opts.use_page_cache) {
2061
8.59k
        _reader->disable_index_meta_cache();
2062
8.59k
    }
2063
8.59k
    RETURN_IF_ERROR(get_block_compression_codec(_reader->get_compression(), &_compress_codec));
2064
8.59k
    if (config::enable_low_cardinality_optimize &&
2065
8.59k
        opts.io_ctx.reader_type == ReaderType::READER_QUERY &&
2066
8.59k
        _reader->encoding_info()->encoding() == DICT_ENCODING) {
2067
147
        auto dict_encoding_type = _reader->get_dict_encoding_type();
2068
        // Only if the column is a predicate column, then we need check the all dict encoding flag
2069
        // because we could rewrite the predciate to accelarate query speed. But if it is not a
2070
        // predicate column, then it is useless. And it has a bad impact on cold read(first time read)
2071
        // because it will load the column's ordinal index and zonemap index and maybe other indices.
2072
        // it has bad impact on primary key query. For example, select * from table where pk = 1, and
2073
        // the table has 2000 columns.
2074
147
        if (dict_encoding_type == ColumnReader::UNKNOWN_DICT_ENCODING && opts.is_predicate_column) {
2075
33
            RETURN_IF_ERROR(seek_to_ordinal(_reader->num_rows() - 1));
2076
33
            _is_all_dict_encoding = _page.is_dict_encoding;
2077
33
            _reader->set_dict_encoding_type(_is_all_dict_encoding
2078
33
                                                    ? ColumnReader::ALL_DICT_ENCODING
2079
33
                                                    : ColumnReader::PARTIAL_DICT_ENCODING);
2080
114
        } else {
2081
114
            _is_all_dict_encoding = dict_encoding_type == ColumnReader::ALL_DICT_ENCODING;
2082
114
        }
2083
147
    }
2084
8.59k
    return Status::OK();
2085
8.59k
}
2086
2087
8.64k
FileColumnIterator::~FileColumnIterator() = default;
2088
2089
0
void FileColumnIterator::_trigger_prefetch_if_eligible(ordinal_t ord) {
2090
0
    std::vector<BlockRange> ranges;
2091
0
    if (_prefetcher->need_prefetch(cast_set<uint32_t>(ord), &ranges)) {
2092
0
        for (const auto& range : ranges) {
2093
0
            _cached_remote_file_reader->prefetch_range(range.offset, range.size, &_opts.io_ctx);
2094
0
        }
2095
0
    }
2096
0
}
2097
2098
24.5k
Status FileColumnIterator::seek_to_ordinal(ordinal_t ord) {
2099
24.5k
    if (_reading_flag == ReadingFlag::SKIP_READING) {
2100
0
        DLOG(INFO) << "File column iterator column " << _column_name << " skip reading.";
2101
0
        return Status::OK();
2102
0
    }
2103
2104
24.5k
    LOG_IF(INFO, config::enable_segment_prefetch_verbose_log) << fmt::format(
2105
0
            "[verbose] FileColumnIterator::seek_to_ordinal seek to ordinal {}, enable_prefetch={}",
2106
0
            ord, _enable_prefetch);
2107
24.5k
    if (_enable_prefetch) {
2108
0
        _trigger_prefetch_if_eligible(ord);
2109
0
    }
2110
2111
    // if current page contains this row, we don't need to seek
2112
24.5k
    if (!_page || !_page.contains(ord) || !_page_iter.valid()) {
2113
9.06k
        RETURN_IF_ERROR(_reader->seek_at_or_before(ord, &_page_iter, _opts));
2114
9.06k
        RETURN_IF_ERROR(_read_data_page(_page_iter));
2115
9.06k
    }
2116
24.5k
    RETURN_IF_ERROR(_seek_to_pos_in_page(&_page, ord - _page.first_ordinal));
2117
24.5k
    _current_ordinal = ord;
2118
24.5k
    return Status::OK();
2119
24.5k
}
2120
2121
0
Status FileColumnIterator::seek_to_page_start() {
2122
0
    return seek_to_ordinal(_page.first_ordinal);
2123
0
}
2124
2125
26.3k
Status FileColumnIterator::_seek_to_pos_in_page(ParsedPage* page, ordinal_t offset_in_page) const {
2126
26.3k
    if (page->offset_in_page == offset_in_page) {
2127
        // fast path, do nothing
2128
22.9k
        return Status::OK();
2129
22.9k
    }
2130
2131
3.31k
    ordinal_t pos_in_data = offset_in_page;
2132
3.31k
    if (_page.has_null) {
2133
5
        ordinal_t offset_in_data = 0;
2134
5
        ordinal_t skips = offset_in_page;
2135
2136
5
        if (offset_in_page > page->offset_in_page) {
2137
            // forward, reuse null bitmap
2138
3
            skips = offset_in_page - page->offset_in_page;
2139
3
            offset_in_data = page->data_decoder->current_index();
2140
3
        } else {
2141
            // rewind null bitmap, and
2142
2
            page->null_decoder = RleDecoder<bool>((const uint8_t*)page->null_bitmap.data,
2143
2
                                                  cast_set<int>(page->null_bitmap.size), 1);
2144
2
        }
2145
2146
5
        auto skip_nulls = page->null_decoder.Skip(skips);
2147
5
        pos_in_data = offset_in_data + skips - skip_nulls;
2148
5
    }
2149
2150
3.31k
    RETURN_IF_ERROR(page->data_decoder->seek_to_position_in_page(pos_in_data));
2151
3.31k
    page->offset_in_page = offset_in_page;
2152
3.31k
    return Status::OK();
2153
3.31k
}
2154
2155
0
Status FileColumnIterator::next_batch_of_zone_map(size_t* n, MutableColumnPtr& dst) {
2156
0
    return _reader->next_batch_of_zone_map(n, dst);
2157
0
}
2158
2159
20.5k
Status FileColumnIterator::next_batch(size_t* n, MutableColumnPtr& dst, bool* has_null) {
2160
20.5k
    if (read_null_map_only()) {
2161
0
        DLOG(INFO) << "File column iterator column " << _column_name
2162
0
                   << " in NULL_MAP_ONLY mode, reading only null map.";
2163
0
        DORIS_CHECK(is_column_nullable(*dst));
2164
0
        auto& nullable_col = assert_cast<ColumnNullable&>(*dst);
2165
0
        auto& null_map_data = nullable_col.get_null_map_data();
2166
2167
0
        size_t remaining = *n;
2168
0
        *has_null = false;
2169
0
        while (remaining > 0) {
2170
0
            if (!_page.has_remaining()) {
2171
0
                bool eos = false;
2172
0
                RETURN_IF_ERROR(_load_next_page(&eos));
2173
0
                if (eos) {
2174
0
                    break;
2175
0
                }
2176
0
            }
2177
2178
0
            size_t nrows_in_page = std::min(remaining, _page.remaining());
2179
0
            size_t nrows_to_read = nrows_in_page;
2180
0
            if (_page.has_null) {
2181
0
                while (nrows_to_read > 0) {
2182
0
                    bool is_null = false;
2183
0
                    size_t this_run = _page.null_decoder.GetNextRun(&is_null, nrows_to_read);
2184
0
                    const size_t cur_size = null_map_data.size();
2185
0
                    null_map_data.resize(cur_size + this_run);
2186
0
                    memset(null_map_data.data() + cur_size, is_null ? 1 : 0, this_run);
2187
0
                    if (is_null) {
2188
0
                        *has_null = true;
2189
0
                    }
2190
0
                    nrows_to_read -= this_run;
2191
0
                    _page.offset_in_page += this_run;
2192
0
                    _current_ordinal += this_run;
2193
0
                }
2194
0
            } else {
2195
0
                const size_t cur_size = null_map_data.size();
2196
0
                null_map_data.resize(cur_size + nrows_to_read);
2197
0
                memset(null_map_data.data() + cur_size, 0, nrows_to_read);
2198
0
                _page.offset_in_page += nrows_to_read;
2199
0
                _current_ordinal += nrows_to_read;
2200
0
            }
2201
0
            remaining -= nrows_in_page;
2202
0
        }
2203
0
        *n -= remaining;
2204
0
        nullable_col.get_nested_column().insert_many_defaults(*n);
2205
0
        return Status::OK();
2206
0
    }
2207
2208
20.5k
    if (_reading_flag == ReadingFlag::SKIP_READING) {
2209
0
        DLOG(INFO) << "File column iterator column " << _column_name << " skip reading.";
2210
0
        dst->insert_many_defaults(*n);
2211
0
        return Status::OK();
2212
0
    }
2213
2214
20.5k
    size_t curr_size = dst->byte_size();
2215
20.5k
    dst->reserve(*n);
2216
20.5k
    size_t remaining = *n;
2217
20.5k
    *has_null = false;
2218
42.8k
    while (remaining > 0) {
2219
22.2k
        if (!_page.has_remaining()) {
2220
1.76k
            bool eos = false;
2221
1.76k
            RETURN_IF_ERROR(_load_next_page(&eos));
2222
1.76k
            if (eos) {
2223
0
                break;
2224
0
            }
2225
1.76k
        }
2226
2227
        // number of rows to be read from this page
2228
22.2k
        size_t nrows_in_page = std::min(remaining, _page.remaining());
2229
22.2k
        size_t nrows_to_read = nrows_in_page;
2230
22.2k
        if (_page.has_null) {
2231
20.5k
            while (nrows_to_read > 0) {
2232
20.3k
                bool is_null = false;
2233
20.3k
                size_t this_run = _page.null_decoder.GetNextRun(&is_null, nrows_to_read);
2234
                // we use num_rows only for CHECK
2235
20.3k
                size_t num_rows = this_run;
2236
20.3k
                if (!is_null) {
2237
10.2k
                    RETURN_IF_ERROR(_page.data_decoder->next_batch(&num_rows, dst));
2238
10.2k
                    DCHECK_EQ(this_run, num_rows);
2239
10.2k
                } else {
2240
10.0k
                    *has_null = true;
2241
10.0k
                    auto* null_col = check_and_get_column<ColumnNullable>(dst.get());
2242
10.0k
                    if (null_col != nullptr) {
2243
10.0k
                        null_col->insert_many_defaults(this_run);
2244
10.0k
                    } else {
2245
0
                        return Status::InternalError("unexpected column type in column reader");
2246
0
                    }
2247
10.0k
                }
2248
2249
20.3k
                nrows_to_read -= this_run;
2250
20.3k
                _page.offset_in_page += this_run;
2251
20.3k
                _current_ordinal += this_run;
2252
20.3k
            }
2253
22.0k
        } else {
2254
22.0k
            RETURN_IF_ERROR(_page.data_decoder->next_batch(&nrows_to_read, dst));
2255
22.0k
            DCHECK_EQ(nrows_to_read, nrows_in_page);
2256
2257
22.0k
            _page.offset_in_page += nrows_to_read;
2258
22.0k
            _current_ordinal += nrows_to_read;
2259
22.0k
        }
2260
22.2k
        remaining -= nrows_in_page;
2261
22.2k
    }
2262
20.5k
    *n -= remaining;
2263
20.5k
    _opts.stats->bytes_read += (dst->byte_size() - curr_size) + BitmapSize(*n);
2264
2265
20.5k
#ifdef BE_TEST
2266
20.5k
    _reader->check_data_by_zone_map_for_test(dst);
2267
20.5k
#endif
2268
20.5k
    return Status::OK();
2269
20.5k
}
2270
2271
Status FileColumnIterator::read_by_rowids(const rowid_t* rowids, const size_t count,
2272
3.47k
                                          MutableColumnPtr& dst) {
2273
3.47k
    if (read_null_map_only()) {
2274
0
        DLOG(INFO) << "File column iterator column " << _column_name
2275
0
                   << " in NULL_MAP_ONLY mode, reading only null map by rowids.";
2276
2277
0
        DORIS_CHECK(is_column_nullable(*dst));
2278
0
        auto& nullable_col = assert_cast<ColumnNullable&>(*dst);
2279
0
        auto& null_map_data = nullable_col.get_null_map_data();
2280
0
        const size_t base_size = null_map_data.size();
2281
0
        null_map_data.resize(base_size + count);
2282
2283
0
        size_t remaining = count;
2284
0
        size_t total_read_count = 0;
2285
0
        size_t nrows_to_read = 0;
2286
0
        while (remaining > 0) {
2287
0
            RETURN_IF_ERROR(seek_to_ordinal(rowids[total_read_count]));
2288
2289
0
            nrows_to_read = std::min(remaining, _page.remaining());
2290
2291
0
            if (_page.has_null) {
2292
0
                size_t already_read = 0;
2293
0
                while ((nrows_to_read - already_read) > 0) {
2294
0
                    bool is_null = false;
2295
0
                    size_t this_run = std::min(nrows_to_read - already_read, _page.remaining());
2296
0
                    if (UNLIKELY(this_run == 0)) {
2297
0
                        break;
2298
0
                    }
2299
0
                    this_run = _page.null_decoder.GetNextRun(&is_null, this_run);
2300
2301
0
                    size_t offset = total_read_count + already_read;
2302
0
                    size_t this_read_count = 0;
2303
0
                    rowid_t current_ordinal_in_page =
2304
0
                            cast_set<uint32_t>(_page.offset_in_page + _page.first_ordinal);
2305
0
                    for (size_t i = 0; i < this_run; ++i) {
2306
0
                        if (rowids[offset + i] - current_ordinal_in_page >= this_run) {
2307
0
                            break;
2308
0
                        }
2309
0
                        this_read_count++;
2310
0
                    }
2311
2312
0
                    if (this_read_count > 0) {
2313
0
                        memset(null_map_data.data() + base_size + offset, is_null ? 1 : 0,
2314
0
                               this_read_count);
2315
0
                    }
2316
2317
0
                    already_read += this_read_count;
2318
0
                    _page.offset_in_page += this_run;
2319
0
                }
2320
2321
0
                nrows_to_read = already_read;
2322
0
                total_read_count += nrows_to_read;
2323
0
                remaining -= nrows_to_read;
2324
0
            } else {
2325
0
                memset(null_map_data.data() + base_size + total_read_count, 0, nrows_to_read);
2326
0
                total_read_count += nrows_to_read;
2327
0
                remaining -= nrows_to_read;
2328
0
            }
2329
0
        }
2330
2331
0
        null_map_data.resize(base_size + total_read_count);
2332
0
        nullable_col.get_nested_column().insert_many_defaults(total_read_count);
2333
0
        return Status::OK();
2334
0
    }
2335
2336
3.47k
    if (_reading_flag == ReadingFlag::SKIP_READING) {
2337
0
        DLOG(INFO) << "File column iterator column " << _column_name << " skip reading.";
2338
0
        dst->insert_many_defaults(count);
2339
0
        return Status::OK();
2340
0
    }
2341
2342
3.47k
    size_t remaining = count;
2343
3.47k
    size_t total_read_count = 0;
2344
3.47k
    size_t nrows_to_read = 0;
2345
7.45k
    while (remaining > 0) {
2346
3.98k
        RETURN_IF_ERROR(seek_to_ordinal(rowids[total_read_count]));
2347
2348
        // number of rows to be read from this page
2349
3.98k
        nrows_to_read = std::min(remaining, _page.remaining());
2350
2351
3.98k
        if (_page.has_null) {
2352
9
            size_t already_read = 0;
2353
570
            while ((nrows_to_read - already_read) > 0) {
2354
561
                bool is_null = false;
2355
561
                size_t this_run = std::min(nrows_to_read - already_read, _page.remaining());
2356
561
                if (UNLIKELY(this_run == 0)) {
2357
0
                    break;
2358
0
                }
2359
561
                this_run = _page.null_decoder.GetNextRun(&is_null, this_run);
2360
561
                size_t offset = total_read_count + already_read;
2361
561
                size_t this_read_count = 0;
2362
561
                rowid_t current_ordinal_in_page =
2363
561
                        cast_set<uint32_t>(_page.offset_in_page + _page.first_ordinal);
2364
855
                for (size_t i = 0; i < this_run; ++i) {
2365
804
                    if (rowids[offset + i] - current_ordinal_in_page >= this_run) {
2366
510
                        break;
2367
510
                    }
2368
294
                    this_read_count++;
2369
294
                }
2370
2371
561
                auto origin_index = _page.data_decoder->current_index();
2372
561
                if (this_read_count > 0) {
2373
222
                    if (is_null) {
2374
50
                        auto* null_col = check_and_get_column<ColumnNullable>(dst.get());
2375
50
                        if (UNLIKELY(null_col == nullptr)) {
2376
0
                            return Status::InternalError("unexpected column type in column reader");
2377
0
                        }
2378
2379
50
                        null_col->insert_many_defaults(this_read_count);
2380
172
                    } else {
2381
172
                        size_t read_count = this_read_count;
2382
2383
                        // ordinal in nullable columns' data buffer maybe be not continuously(the data doesn't contain null value),
2384
                        // so we need use `page_start_off_in_decoder` to calculate the actual offset in `data_decoder`
2385
172
                        size_t page_start_off_in_decoder =
2386
172
                                _page.first_ordinal + _page.offset_in_page - origin_index;
2387
172
                        RETURN_IF_ERROR(_page.data_decoder->read_by_rowids(
2388
172
                                &rowids[offset], page_start_off_in_decoder, &read_count, dst));
2389
172
                        DCHECK_EQ(read_count, this_read_count);
2390
172
                    }
2391
222
                }
2392
2393
561
                if (!is_null) {
2394
291
                    RETURN_IF_ERROR(
2395
291
                            _page.data_decoder->seek_to_position_in_page(origin_index + this_run));
2396
291
                }
2397
2398
561
                already_read += this_read_count;
2399
561
                _page.offset_in_page += this_run;
2400
561
                DCHECK(_page.offset_in_page <= _page.num_rows);
2401
561
            }
2402
2403
9
            nrows_to_read = already_read;
2404
9
            total_read_count += nrows_to_read;
2405
9
            remaining -= nrows_to_read;
2406
3.97k
        } else {
2407
3.97k
            RETURN_IF_ERROR(_page.data_decoder->read_by_rowids(
2408
3.97k
                    &rowids[total_read_count], _page.first_ordinal, &nrows_to_read, dst));
2409
3.97k
            total_read_count += nrows_to_read;
2410
3.97k
            remaining -= nrows_to_read;
2411
3.97k
        }
2412
3.98k
    }
2413
3.47k
    return Status::OK();
2414
3.47k
}
2415
2416
1.76k
Status FileColumnIterator::_load_next_page(bool* eos) {
2417
1.76k
    _page_iter.next();
2418
1.76k
    if (!_page_iter.valid()) {
2419
0
        *eos = true;
2420
0
        return Status::OK();
2421
0
    }
2422
2423
1.76k
    RETURN_IF_ERROR(_read_data_page(_page_iter));
2424
1.76k
    RETURN_IF_ERROR(_seek_to_pos_in_page(&_page, 0));
2425
1.76k
    *eos = false;
2426
1.76k
    return Status::OK();
2427
1.76k
}
2428
2429
10.8k
Status FileColumnIterator::_read_data_page(const OrdinalPageIndexIterator& iter) {
2430
10.8k
    PageHandle handle;
2431
10.8k
    Slice page_body;
2432
10.8k
    PageFooterPB footer;
2433
10.8k
    _opts.type = DATA_PAGE;
2434
10.8k
    PageDecoderOptions decoder_opts;
2435
10.8k
    decoder_opts.only_read_offsets = _opts.only_read_offsets;
2436
10.8k
    RETURN_IF_ERROR(
2437
10.8k
            _reader->read_page(_opts, iter.page(), &handle, &page_body, &footer, _compress_codec));
2438
    // parse data page
2439
10.8k
    auto st = ParsedPage::create(std::move(handle), page_body, footer.data_page_footer(),
2440
10.8k
                                 _reader->encoding_info(), iter.page(), iter.page_index(), &_page,
2441
10.8k
                                 decoder_opts);
2442
10.8k
    if (!st.ok()) {
2443
0
        LOG(WARNING) << "failed to create ParsedPage, file=" << _opts.file_reader->path().native()
2444
0
                     << ", page_offset=" << iter.page().offset << ", page_size=" << iter.page().size
2445
0
                     << ", page_index=" << iter.page_index() << ", error=" << st;
2446
0
        return st;
2447
0
    }
2448
2449
    // dictionary page is read when the first data page that uses it is read,
2450
    // this is to optimize the memory usage: when there is no query on one column, we could
2451
    // release the memory of dictionary page.
2452
    // note that concurrent iterators for the same column won't repeatedly read dictionary page
2453
    // because of page cache.
2454
10.8k
    if (_reader->encoding_info()->encoding() == DICT_ENCODING) {
2455
4.72k
        auto dict_page_decoder = reinterpret_cast<BinaryDictPageDecoder*>(_page.data_decoder.get());
2456
4.72k
        if (dict_page_decoder->is_dict_encoding()) {
2457
3.09k
            if (_dict_decoder == nullptr) {
2458
3.09k
                RETURN_IF_ERROR(_read_dict_data());
2459
3.09k
                CHECK_NOTNULL(_dict_decoder);
2460
3.09k
            }
2461
2462
3.09k
            dict_page_decoder->set_dict_decoder(cast_set<uint32_t>(_dict_decoder->count()),
2463
3.09k
                                                _dict_word_info.get());
2464
3.09k
        }
2465
4.72k
    }
2466
10.8k
    return Status::OK();
2467
10.8k
}
2468
2469
3.09k
Status FileColumnIterator::_read_dict_data() {
2470
3.09k
    CHECK_EQ(_reader->encoding_info()->encoding(), DICT_ENCODING);
2471
    // read dictionary page
2472
3.09k
    Slice dict_data;
2473
3.09k
    PageFooterPB dict_footer;
2474
3.09k
    _opts.type = INDEX_PAGE;
2475
2476
3.09k
    RETURN_IF_ERROR(_reader->read_page(_opts, _reader->get_dict_page_pointer(), &_dict_page_handle,
2477
3.09k
                                       &dict_data, &dict_footer, _compress_codec));
2478
3.09k
    const EncodingInfo* encoding_info;
2479
    // The dict pool stores strings of the outer column's type. Using the
2480
    // outer type (CHAR vs VARCHAR/STRING) lets the EncodingInfo pick a
2481
    // CHAR-strip pre-decoder so the cached dict page is already unpadded.
2482
3.09k
    RETURN_IF_ERROR(EncodingInfo::get(_reader->get_meta_type(),
2483
3.09k
                                      dict_footer.dict_page_footer().encoding(), &encoding_info));
2484
3.09k
    RETURN_IF_ERROR(encoding_info->create_page_decoder(dict_data, {}, _dict_decoder));
2485
3.09k
    RETURN_IF_ERROR(_dict_decoder->init());
2486
2487
3.09k
    _dict_word_info.reset(new StringRef[_dict_decoder->count()]);
2488
3.09k
    RETURN_IF_ERROR(_dict_decoder->get_dict_word_info(_dict_word_info.get()));
2489
3.09k
    return Status::OK();
2490
3.09k
}
2491
2492
Status FileColumnIterator::get_row_ranges_by_zone_map(
2493
        const AndBlockColumnPredicate* col_predicates,
2494
        const std::vector<std::shared_ptr<const ColumnPredicate>>* delete_predicates,
2495
63
        RowRanges* row_ranges) {
2496
63
    VLOG_DEBUG << fmt::format("file column zonemap column={} has_zone_map={} rows={}",
2497
0
                              column_name(), _reader->has_zone_map(), _reader->num_rows());
2498
63
    if (_reader->has_zone_map()) {
2499
63
        RETURN_IF_ERROR(_reader->get_row_ranges_by_zone_map(col_predicates, delete_predicates,
2500
63
                                                            row_ranges, _opts));
2501
63
    }
2502
63
    return Status::OK();
2503
63
}
2504
2505
Status FileColumnIterator::get_row_ranges_by_bloom_filter(
2506
63
        const AndBlockColumnPredicate* col_predicates, RowRanges* row_ranges) {
2507
63
    if ((col_predicates->can_do_bloom_filter(false) && _reader->has_bloom_filter_index(false)) ||
2508
63
        (col_predicates->can_do_bloom_filter(true) && _reader->has_bloom_filter_index(true))) {
2509
3
        RETURN_IF_ERROR(_reader->get_row_ranges_by_bloom_filter(col_predicates, row_ranges, _opts));
2510
3
    }
2511
63
    return Status::OK();
2512
63
}
2513
2514
Status FileColumnIterator::get_row_ranges_by_dict(const AndBlockColumnPredicate* col_predicates,
2515
63
                                                  RowRanges* row_ranges) {
2516
63
    if (!_is_all_dict_encoding) {
2517
30
        return Status::OK();
2518
30
    }
2519
2520
33
    if (!_dict_decoder) {
2521
0
        RETURN_IF_ERROR(_read_dict_data());
2522
0
        CHECK_NOTNULL(_dict_decoder);
2523
0
    }
2524
2525
33
    if (!col_predicates->evaluate_and(_dict_word_info.get(), _dict_decoder->count())) {
2526
0
        row_ranges->clear();
2527
0
    }
2528
33
    return Status::OK();
2529
33
}
2530
2531
0
Status FileColumnIterator::init_prefetcher(const SegmentPrefetchParams& params) {
2532
0
    if (_cached_remote_file_reader =
2533
0
                std::dynamic_pointer_cast<io::CachedRemoteFileReader>(_reader->_file_reader);
2534
0
        !_cached_remote_file_reader) {
2535
0
        return Status::OK();
2536
0
    }
2537
0
    _enable_prefetch = true;
2538
0
    _prefetcher = std::make_unique<SegmentPrefetcher>(params.config);
2539
0
    RETURN_IF_ERROR(_prefetcher->init(_reader, params.read_options));
2540
0
    return Status::OK();
2541
0
}
2542
2543
void FileColumnIterator::collect_prefetchers(
2544
        std::map<PrefetcherInitMethod, std::vector<SegmentPrefetcher*>>& prefetchers,
2545
0
        PrefetcherInitMethod init_method) {
2546
0
    if (_prefetcher) {
2547
0
        prefetchers[init_method].emplace_back(_prefetcher.get());
2548
0
    }
2549
0
}
2550
2551
31
Status DefaultValueColumnIterator::init(const ColumnIteratorOptions& opts) {
2552
31
    _opts = opts;
2553
    // be consistent with segment v1
2554
    // if _has_default_value, we should create default column iterator for this column, and
2555
    // "NULL" is a special default value which means the default value is null.
2556
31
    if (_has_default_value) {
2557
7
        if (_default_value == "NULL") {
2558
7
            _default_value_field = Field::create_field<TYPE_NULL>(Null {});
2559
7
        } else {
2560
0
            if (_type == FieldType::OLAP_FIELD_TYPE_ARRAY) {
2561
0
                if (_default_value != "[]") {
2562
0
                    return Status::NotSupported("Array default {} is unsupported", _default_value);
2563
0
                } else {
2564
0
                    _default_value_field = Field::create_field<TYPE_ARRAY>(Array {});
2565
0
                    return Status::OK();
2566
0
                }
2567
0
            } else if (_type == FieldType::OLAP_FIELD_TYPE_STRUCT) {
2568
0
                return Status::NotSupported("STRUCT default type is unsupported");
2569
0
            } else if (_type == FieldType::OLAP_FIELD_TYPE_MAP) {
2570
0
                return Status::NotSupported("MAP default type is unsupported");
2571
0
            }
2572
0
            const auto t = _type;
2573
0
            const auto serde = DataTypeFactory::instance()
2574
0
                                       .create_data_type(t, _precision, _scale, _len)
2575
0
                                       ->get_serde();
2576
0
            RETURN_IF_ERROR(serde->from_fe_string(_default_value, _default_value_field));
2577
0
        }
2578
24
    } else if (_is_nullable) {
2579
24
        _default_value_field = Field::create_field<TYPE_NULL>(Null {});
2580
24
    } else {
2581
0
        return Status::InternalError(
2582
0
                "invalid default value column for no default value and not nullable");
2583
0
    }
2584
31
    return Status::OK();
2585
31
}
2586
2587
11
Status DefaultValueColumnIterator::next_batch(size_t* n, MutableColumnPtr& dst, bool* has_null) {
2588
11
    *has_null = _default_value_field.is_null();
2589
11
    _insert_many_default(dst, *n);
2590
11
    return Status::OK();
2591
11
}
2592
2593
Status DefaultValueColumnIterator::read_by_rowids(const rowid_t* rowids, const size_t count,
2594
3
                                                  MutableColumnPtr& dst) {
2595
3
    _insert_many_default(dst, count);
2596
3
    return Status::OK();
2597
3
}
2598
2599
14
void DefaultValueColumnIterator::_insert_many_default(MutableColumnPtr& dst, size_t n) {
2600
14
    if (_default_value_field.is_null()) {
2601
14
        dst->insert_many_defaults(n);
2602
14
    } else {
2603
0
        dst = dst->convert_to_predicate_column_if_dictionary();
2604
0
        dst->insert_duplicate_fields(_default_value_field, n);
2605
0
    }
2606
14
}
2607
2608
0
Status RowIdColumnIteratorV2::next_batch(size_t* n, MutableColumnPtr& dst, bool* has_null) {
2609
0
    auto* string_column = assert_cast<ColumnString*, TypeCheckOnRelease::DISABLE>(dst.get());
2610
2611
0
    for (uint32_t i = 0; i < *n; ++i) {
2612
0
        uint32_t row_id = _current_rowid + i;
2613
0
        GlobalRowLoacationV2 location(_version, _backend_id, _file_id, row_id);
2614
0
        string_column->insert_data(reinterpret_cast<const char*>(&location),
2615
0
                                   sizeof(GlobalRowLoacationV2));
2616
0
    }
2617
0
    _current_rowid += *n;
2618
0
    return Status::OK();
2619
0
}
2620
2621
Status RowIdColumnIteratorV2::read_by_rowids(const rowid_t* rowids, const size_t count,
2622
16
                                             MutableColumnPtr& dst) {
2623
16
    auto* string_column = assert_cast<ColumnString*>(dst.get());
2624
2625
41
    for (size_t i = 0; i < count; ++i) {
2626
25
        uint32_t row_id = rowids[i];
2627
25
        GlobalRowLoacationV2 location(_version, _backend_id, _file_id, row_id);
2628
25
        string_column->insert_data(reinterpret_cast<const char*>(&location),
2629
25
                                   sizeof(GlobalRowLoacationV2));
2630
25
    }
2631
16
    return Status::OK();
2632
16
}
2633
2634
} // namespace doris::segment_v2