Coverage Report

Created: 2026-06-17 11:50

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