Coverage Report

Created: 2026-07-27 03:00

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
be/src/exec/scan/file_scanner_v2.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 "exec/scan/file_scanner_v2.h"
19
20
#include <gen_cpp/Exprs_types.h>
21
#include <gen_cpp/PlanNodes_types.h>
22
23
#include <algorithm>
24
#include <map>
25
#include <memory>
26
#include <optional>
27
#include <string>
28
#include <utility>
29
30
#include "common/cast_set.h"
31
#include "common/config.h"
32
#include "common/consts.h"
33
#include "common/metrics/doris_metrics.h"
34
#include "common/status.h"
35
#include "core/assert_cast.h"
36
#include "core/block/column_with_type_and_name.h"
37
#include "core/column/column.h"
38
#include "core/data_type/data_type.h"
39
#include "core/data_type/data_type_nullable.h"
40
#include "core/data_type_serde/data_type_serde.h"
41
#include "core/string_ref.h"
42
#include "exec/common/util.hpp"
43
#include "exec/operator/scan_operator.h"
44
#include "exec/scan/access_path_parser.h"
45
#include "exec/scan/file_scan_io_context.h"
46
#include "exprs/runtime_filter_expr.h"
47
#include "exprs/vexpr.h"
48
#include "exprs/vexpr_context.h"
49
#include "exprs/vslot_ref.h"
50
#include "format/format_common.h"
51
#include "format/table/iceberg_scan_semantics.h"
52
#include "format_v2/column_mapper.h"
53
#include "format_v2/jni/iceberg_sys_table_reader.h"
54
#include "format_v2/jni/jdbc_reader.h"
55
#include "format_v2/jni/max_compute_jni_reader.h"
56
#include "format_v2/jni/trino_connector_jni_reader.h"
57
#include "format_v2/table/hive_reader.h"
58
#include "format_v2/table/hudi_reader.h"
59
#include "format_v2/table/iceberg_position_delete_sys_table_reader.h"
60
#include "format_v2/table/iceberg_reader.h"
61
#include "format_v2/table/paimon_reader.h"
62
#include "format_v2/table/remote_doris_reader.h"
63
#include "format_v2/table_reader.h"
64
#include "format_v2/wal/wal_table_reader.h"
65
#include "io/cache/block_file_cache_profile.h"
66
#include "io/fs/file_meta_cache.h"
67
#include "io/io_common.h"
68
#include "runtime/descriptors.h"
69
#include "runtime/exec_env.h"
70
#include "runtime/file_scan_profile.h"
71
#include "runtime/runtime_state.h"
72
#include "service/backend_options.h"
73
#include "storage/id_manager.h"
74
75
namespace doris {
76
namespace {
77
78
constexpr int kIcebergPositionDeleteContent = 1;
79
constexpr int kIcebergDeletionVectorContent = 3;
80
81
44
std::string table_format_name(const TFileRangeDesc& range) {
82
44
    return range.__isset.table_format_params ? range.table_format_params.table_format_type
83
44
                                             : "NotSet";
84
44
}
85
86
TFileFormatType::type get_range_format_type(const TFileScanRangeParams& params,
87
47
                                            const TFileRangeDesc& range) {
88
47
    return range.__isset.format_type ? range.format_type : params.format_type;
89
47
}
90
91
32
bool is_supported_table_format(const TFileRangeDesc& range) {
92
32
    const auto table_format = table_format_name(range);
93
32
    if (table_format == "hudi" && range.__isset.table_format_params &&
94
32
        range.table_format_params.__isset.hudi_params &&
95
32
        range.table_format_params.hudi_params.__isset.delta_logs &&
96
32
        !range.table_format_params.hudi_params.delta_logs.empty()) {
97
        // Hudi MOR splits need log-file merge semantics and must stay on the existing JNI path.
98
        // FileScannerV2 currently supports native Parquet data files only.
99
1
        return false;
100
1
    }
101
31
    return table_format == "NotSet" || table_format == "tvf" || table_format == "hive" ||
102
31
           table_format == "iceberg" || table_format == "paimon" || table_format == "hudi";
103
32
}
104
105
3
bool is_supported_arrow_table_format(const TFileRangeDesc& range) {
106
3
    return table_format_name(range) == "remote_doris";
107
3
}
108
109
6
bool is_supported_jni_table_format(const TFileRangeDesc& range) {
110
6
    const auto table_format = table_format_name(range);
111
6
    if (table_format == "paimon") {
112
3
        if (!range.__isset.table_format_params ||
113
3
            !range.table_format_params.__isset.paimon_params) {
114
0
            return false;
115
0
        }
116
3
        const auto& params = range.table_format_params.paimon_params;
117
3
        if (params.__isset.reader_type) {
118
2
            if (params.reader_type == TPaimonReaderType::PAIMON_JNI) {
119
0
                return params.__isset.paimon_split;
120
0
            }
121
            // V2 cannot pass a logical DataSplit through a raw native child without silently
122
            // dropping its multi-file semantics, so PAIMON_CPP must remain on the V1 fallback.
123
2
            return false;
124
2
        }
125
1
        if (params.__isset.paimon_split) {
126
            // Before reader_type was added, an encoded split unambiguously selected the Java
127
            // reader; native scans carried only their physical Parquet or ORC range.
128
1
            return true;
129
1
        }
130
0
        return params.__isset.file_format &&
131
0
               (params.file_format == "parquet" || params.file_format == "orc");
132
1
    }
133
3
    return table_format == "jdbc" || table_format == "iceberg" || table_format == "hudi" ||
134
3
           table_format == "max_compute" || table_format == "trino_connector";
135
6
}
136
137
0
bool is_iceberg_position_deletes_sys_table(const TFileRangeDesc& range) {
138
0
    return range.__isset.table_format_params &&
139
0
           range.table_format_params.table_format_type == "iceberg" &&
140
0
           range.table_format_params.__isset.iceberg_params &&
141
0
           range.table_format_params.iceberg_params.__isset.content &&
142
0
           (range.table_format_params.iceberg_params.content == kIcebergPositionDeleteContent ||
143
0
            range.table_format_params.iceberg_params.content == kIcebergDeletionVectorContent);
144
0
}
145
146
18
bool is_csv_format(TFileFormatType::type format_type) {
147
18
    switch (format_type) {
148
2
    case TFileFormatType::FORMAT_CSV_PLAIN:
149
3
    case TFileFormatType::FORMAT_CSV_GZ:
150
4
    case TFileFormatType::FORMAT_CSV_BZ2:
151
5
    case TFileFormatType::FORMAT_CSV_LZ4FRAME:
152
6
    case TFileFormatType::FORMAT_CSV_LZ4BLOCK:
153
7
    case TFileFormatType::FORMAT_CSV_LZOP:
154
8
    case TFileFormatType::FORMAT_CSV_DEFLATE:
155
9
    case TFileFormatType::FORMAT_CSV_SNAPPYBLOCK:
156
10
    case TFileFormatType::FORMAT_PROTO:
157
10
        return true;
158
8
    default:
159
8
        return false;
160
18
    }
161
18
}
162
163
8
bool is_text_format(TFileFormatType::type format_type) {
164
8
    return format_type == TFileFormatType::FORMAT_TEXT;
165
8
}
166
167
6
bool is_json_format(TFileFormatType::type format_type) {
168
6
    return format_type == TFileFormatType::FORMAT_JSON;
169
6
}
170
171
4
bool is_native_format(TFileFormatType::type format_type) {
172
4
    return format_type == TFileFormatType::FORMAT_NATIVE;
173
4
}
174
175
19
bool is_wal_format(TFileFormatType::type format_type) {
176
19
    return format_type == TFileFormatType::FORMAT_WAL;
177
19
}
178
179
6
bool is_partition_slot(const TFileScanSlotInfo& slot_info, const std::string& column_name) {
180
6
    if (column_name.starts_with(BeConsts::GLOBAL_ROWID_COL) ||
181
6
        column_name == BeConsts::ICEBERG_ROWID_COL) {
182
2
        return false;
183
2
    }
184
4
    return slot_info.__isset.category ? slot_info.category == TColumnCategory::PARTITION_KEY
185
4
                                      : !slot_info.is_file_slot;
186
6
}
187
188
8
bool is_data_file_slot(const TFileScanSlotInfo& slot_info, const std::string& column_name) {
189
8
    if (column_name.starts_with(BeConsts::GLOBAL_ROWID_COL) ||
190
8
        column_name == BeConsts::ICEBERG_ROWID_COL) {
191
2
        return false;
192
2
    }
193
    // CSV and other non-self-describing formats need FE slot descriptors for only the columns that
194
    // are physically read from the file. Partition/default/virtual columns stay in TableReader's
195
    // mapping layer and are materialized after the file-local block is read. New FE provides an
196
    // explicit category; old FE falls back to `is_file_slot`.
197
6
    if (slot_info.__isset.category) {
198
4
        return slot_info.category == TColumnCategory::REGULAR ||
199
4
               slot_info.category == TColumnCategory::GENERATED;
200
4
    }
201
2
    return slot_info.is_file_slot;
202
6
}
203
204
Status rewrite_slot_refs_to_global_index(
205
        VExprSPtr* expr,
206
7
        const std::unordered_map<int32_t, format::GlobalIndex>& slot_id_to_global_index) {
207
7
    DORIS_CHECK(expr != nullptr);
208
7
    if (*expr == nullptr) {
209
0
        return Status::OK();
210
0
    }
211
7
    if (auto* runtime_filter = dynamic_cast<RuntimeFilterExpr*>(expr->get());
212
7
        runtime_filter != nullptr) {
213
1
        auto impl = runtime_filter->get_impl();
214
1
        DORIS_CHECK(impl != nullptr);
215
1
        RETURN_IF_ERROR(rewrite_slot_refs_to_global_index(&impl, slot_id_to_global_index));
216
1
        runtime_filter->set_impl(std::move(impl));
217
1
        return Status::OK();
218
1
    }
219
6
    if ((*expr)->is_slot_ref()) {
220
4
        const auto* slot_ref = assert_cast<const VSlotRef*>(expr->get());
221
4
        const auto global_index_it = slot_id_to_global_index.find(slot_ref->slot_id());
222
4
        if (global_index_it == slot_id_to_global_index.end()) {
223
1
            return Status::InternalError(
224
1
                    "Can not resolve source slot id {} to a table global index for column {}",
225
1
                    slot_ref->slot_id(), slot_ref->column_name());
226
1
        }
227
3
        const auto global_index = global_index_it->second;
228
3
        *expr = VSlotRef::create_shared(cast_set<int>(global_index.value()),
229
3
                                        cast_set<int>(global_index.value()), -1,
230
3
                                        slot_ref->data_type(), slot_ref->column_name());
231
3
        RETURN_IF_ERROR(expr->get()->prepare(nullptr, RowDescriptor(), nullptr));
232
3
        return Status::OK();
233
3
    }
234
2
    auto children = (*expr)->children();
235
2
    for (auto& child : children) {
236
2
        if (child == nullptr) {
237
0
            continue;
238
0
        }
239
2
        RETURN_IF_ERROR(rewrite_slot_refs_to_global_index(&child, slot_id_to_global_index));
240
2
    }
241
2
    (*expr)->set_children(std::move(children));
242
2
    return Status::OK();
243
2
}
244
245
} // namespace
246
247
#ifdef BE_TEST
248
FileScannerV2::FileScannerV2(RuntimeState* state, RuntimeProfile* profile,
249
                             std::unique_ptr<format::TableReader> table_reader)
250
1
        : Scanner(state, profile), _table_reader(std::move(table_reader)) {}
251
252
Status FileScannerV2::TEST_validate_scan_range(const TFileScanRangeParams& params,
253
3
                                               const TFileRangeDesc& range) {
254
3
    return _validate_scan_range(params, range);
255
3
}
256
257
Status FileScannerV2::TEST_to_file_format(TFileFormatType::type format_type,
258
17
                                          format::FileFormat* file_format) {
259
17
    return _to_file_format(format_type, file_format);
260
17
}
261
262
bool FileScannerV2::TEST_is_partition_slot(const TFileScanSlotInfo& slot_info,
263
6
                                           const std::string& column_name) {
264
6
    return is_partition_slot(slot_info, column_name);
265
6
}
266
267
bool FileScannerV2::TEST_is_data_file_slot(const TFileScanSlotInfo& slot_info,
268
8
                                           const std::string& column_name) {
269
8
    return is_data_file_slot(slot_info, column_name);
270
8
}
271
272
Status FileScannerV2::TEST_rewrite_slot_refs_to_global_index(
273
        VExprSPtr* expr,
274
4
        const std::unordered_map<int32_t, format::GlobalIndex>& slot_id_to_global_index) {
275
4
    return rewrite_slot_refs_to_global_index(expr, slot_id_to_global_index);
276
4
}
277
278
FileScannerV2::RealtimeCounterDeltas FileScannerV2::TEST_collect_realtime_counter_deltas(
279
        const io::FileReaderStats& file_reader_stats,
280
        const io::FileCacheStatistics& file_cache_statistics,
281
        UncachedReaderBytesStorage uncached_reader_bytes_storage, int64_t* last_read_bytes,
282
        int64_t* last_read_rows, int64_t* last_bytes_read_from_local,
283
7
        int64_t* last_bytes_read_from_remote) {
284
7
    return _collect_realtime_counter_deltas(file_reader_stats, file_cache_statistics,
285
7
                                            uncached_reader_bytes_storage, last_read_bytes,
286
7
                                            last_read_rows, last_bytes_read_from_local,
287
7
                                            last_bytes_read_from_remote);
288
7
}
289
290
void FileScannerV2::TEST_report_file_cache_profile(
291
1
        RuntimeProfile* profile, const io::FileCacheStatistics& file_cache_statistics) {
292
1
    _report_file_cache_profile(profile, file_cache_statistics);
293
1
}
294
295
4
bool FileScannerV2::TEST_should_skip_not_found(const Status& status, bool ignore_not_found) {
296
4
    return _should_skip_not_found(status, ignore_not_found);
297
4
}
298
299
4
bool FileScannerV2::TEST_should_skip_empty(const Status& status, bool stopped) {
300
4
    return _should_skip_empty(status, stopped);
301
4
}
302
#endif
303
304
45
bool FileScannerV2::is_supported(const TFileScanRangeParams& params, const TFileRangeDesc& range) {
305
45
    const auto format_type = get_range_format_type(params, range);
306
45
    if (format_type == TFileFormatType::FORMAT_PARQUET ||
307
45
        format_type == TFileFormatType::FORMAT_ORC) {
308
17
        return is_supported_table_format(range);
309
28
    } else if (format_type == TFileFormatType::FORMAT_ARROW) {
310
3
        return is_supported_arrow_table_format(range);
311
25
    } else if (format_type == TFileFormatType::FORMAT_JNI) {
312
6
        return is_supported_jni_table_format(range);
313
19
    } else if (is_wal_format(format_type)) {
314
1
        return table_format_name(range) == "NotSet";
315
18
    } else if (is_csv_format(format_type) || is_text_format(format_type) ||
316
18
               is_json_format(format_type) || is_native_format(format_type)) {
317
15
        return is_supported_table_format(range);
318
15
    } else {
319
3
        LOG(WARNING) << "Unsupported file format type " << format_type << " for file scanner v2";
320
3
        return false;
321
3
    }
322
45
}
323
324
Status FileScannerV2::_validate_scan_range(const TFileScanRangeParams& params,
325
3
                                           const TFileRangeDesc& range) {
326
3
    if (!is_supported(params, range)) {
327
2
        return Status::NotSupported(
328
2
                "FileScannerV2 does not support table format {} with file format {}",
329
2
                table_format_name(range), to_string(get_range_format_type(params, range)));
330
2
    }
331
1
    return Status::OK();
332
3
}
333
334
FileScannerV2::FileScannerV2(RuntimeState* state, FileScanLocalState* local_state, int64_t limit,
335
                             std::shared_ptr<SplitSourceConnector> split_source,
336
                             RuntimeProfile* profile, ShardedKVCache* kv_cache,
337
                             const std::unordered_map<std::string, int>* colname_to_slot_id)
338
0
        : Scanner(state, local_state, limit, profile),
339
0
          _split_source(std::move(split_source)),
340
0
          _kv_cache(kv_cache) {
341
0
    (void)colname_to_slot_id;
342
0
    if (state->get_query_ctx() != nullptr &&
343
0
        state->get_query_ctx()->file_scan_range_params_map.count(local_state->parent_id()) > 0) {
344
0
        _params = &(state->get_query_ctx()->file_scan_range_params_map[local_state->parent_id()]);
345
0
    } else {
346
0
        _params = _split_source->get_params();
347
0
    }
348
0
}
349
350
0
Status FileScannerV2::init(RuntimeState* state, const VExprContextSPtrs& conjuncts) {
351
0
    RETURN_IF_ERROR(Scanner::init(state, conjuncts));
352
0
    auto* profile = _local_state->scanner_profile();
353
0
    const auto hierarchy = file_scan_profile::ensure_hierarchy(profile);
354
0
    _scanner_total_timer = hierarchy.scanner;
355
0
    _io_timer = hierarchy.io;
356
0
    _init_timer = ADD_CHILD_TIMER_WITH_LEVEL(profile, "FileScannerV2InitTime",
357
0
                                             file_scan_profile::SCANNER, 1);
358
0
    _open_timer = ADD_CHILD_TIMER_WITH_LEVEL(profile, "FileScannerV2OpenTime",
359
0
                                             file_scan_profile::SCANNER, 1);
360
0
    _get_block_timer = ADD_CHILD_TIMER_WITH_LEVEL(profile, "FileScannerV2GetBlockTime",
361
0
                                                  file_scan_profile::SCANNER, 1);
362
0
    _prepare_split_timer = ADD_CHILD_TIMER_WITH_LEVEL(profile, "FileScannerV2PrepareSplitTime",
363
0
                                                      file_scan_profile::SCANNER, 1);
364
0
    _get_next_range_timer = ADD_CHILD_TIMER_WITH_LEVEL(profile, "FileScannerV2GetNextRangeTime",
365
0
                                                       file_scan_profile::SCANNER, 1);
366
0
    _close_timer = ADD_CHILD_TIMER_WITH_LEVEL(profile, "FileScannerV2CloseTime",
367
0
                                              file_scan_profile::SCANNER, 1);
368
0
    _empty_file_counter = ADD_CHILD_COUNTER_WITH_LEVEL(profile, "EmptyFileNum", TUnit::UNIT,
369
0
                                                       file_scan_profile::SCANNER, 1);
370
0
    _not_found_file_counter = ADD_CHILD_COUNTER_WITH_LEVEL(profile, "NotFoundFileNum", TUnit::UNIT,
371
0
                                                           file_scan_profile::SCANNER, 1);
372
0
    _file_counter = ADD_CHILD_COUNTER_WITH_LEVEL(profile, "FileNumber", TUnit::UNIT,
373
0
                                                 file_scan_profile::SCANNER, 1);
374
0
    _file_read_bytes_counter = ADD_CHILD_COUNTER_WITH_LEVEL(profile, "FileReadBytes", TUnit::BYTES,
375
0
                                                            file_scan_profile::IO, 1);
376
0
    _file_read_calls_counter = ADD_CHILD_COUNTER_WITH_LEVEL(profile, "FileReadCalls", TUnit::UNIT,
377
0
                                                            file_scan_profile::IO, 1);
378
0
    _file_read_time_counter =
379
0
            ADD_CHILD_TIMER_WITH_LEVEL(profile, "FileReadTime", file_scan_profile::IO, 1);
380
0
    _adaptive_batch_predicted_rows_counter = ADD_CHILD_COUNTER_WITH_LEVEL(
381
0
            profile, "AdaptiveBatchPredictedRows", TUnit::UNIT, file_scan_profile::SCANNER, 1);
382
0
    _adaptive_batch_actual_bytes_counter = ADD_CHILD_COUNTER_WITH_LEVEL(
383
0
            profile, "AdaptiveBatchActualBytes", TUnit::BYTES, file_scan_profile::SCANNER, 1);
384
0
    _adaptive_batch_probe_count_counter = ADD_CHILD_COUNTER_WITH_LEVEL(
385
0
            profile, "AdaptiveBatchProbeCount", TUnit::UNIT, file_scan_profile::SCANNER, 1);
386
0
    SCOPED_TIMER(_scanner_total_timer);
387
0
    SCOPED_TIMER(_init_timer);
388
0
    _file_cache_statistics = std::make_unique<io::FileCacheStatistics>();
389
0
    _file_reader_stats = std::make_unique<io::FileReaderStats>();
390
0
    RETURN_IF_ERROR(_init_io_ctx());
391
0
    _io_ctx->file_cache_stats = _file_cache_statistics.get();
392
0
    _io_ctx->file_reader_stats = _file_reader_stats.get();
393
0
    _io_ctx->is_disposable = _state->query_options().disable_file_cache;
394
0
    return Status::OK();
395
0
}
396
397
0
Status FileScannerV2::_open_impl(RuntimeState* state) {
398
0
    SCOPED_TIMER(_scanner_total_timer);
399
0
    SCOPED_TIMER(_open_timer);
400
0
    RETURN_IF_CANCELLED(state);
401
0
    RETURN_IF_ERROR(Scanner::_open_impl(state));
402
0
    RETURN_IF_ERROR(_get_next_scan_range(&_first_scan_range));
403
0
    if (_first_scan_range) {
404
0
        RETURN_IF_ERROR(_create_table_reader_for_format(_current_range, &_table_reader));
405
0
        DORIS_CHECK(_table_reader != nullptr);
406
0
        RETURN_IF_ERROR(_init_expr_ctxes());
407
0
        RETURN_IF_ERROR(_init_table_reader(_current_range));
408
0
    }
409
0
    return Status::OK();
410
0
}
411
412
0
Status FileScannerV2::_get_next_scan_range(bool* has_next) {
413
0
    SCOPED_TIMER(_get_next_range_timer);
414
0
    DORIS_CHECK(has_next != nullptr);
415
0
    RETURN_IF_ERROR(_split_source->get_next(has_next, &_current_range));
416
0
    if (*has_next) {
417
0
        RETURN_IF_ERROR(_validate_scan_range(*_params, _current_range));
418
0
    }
419
0
    return Status::OK();
420
0
}
421
422
0
Status FileScannerV2::_get_block_impl(RuntimeState* state, Block* block, bool* eof) {
423
0
    SCOPED_TIMER(_scanner_total_timer);
424
0
    SCOPED_TIMER(_get_block_timer);
425
0
    while (true) {
426
0
        RETURN_IF_CANCELLED(state);
427
0
        if (!_has_prepared_split) {
428
0
            RETURN_IF_ERROR(_prepare_next_split(eof));
429
0
            if (*eof) {
430
0
                return Status::OK();
431
0
            }
432
0
        }
433
434
0
        {
435
0
            if (_should_run_adaptive_batch_size()) {
436
0
                _table_reader->set_batch_size(_predict_reader_batch_rows());
437
0
            }
438
0
            const auto status = _table_reader->get_block(block, eof);
439
0
            if (_should_skip_not_found(status, config::ignore_not_found_file_in_external_table)) {
440
0
                RETURN_IF_ERROR(_table_reader->abort_split());
441
0
                COUNTER_UPDATE(_not_found_file_counter, 1);
442
0
                _state->update_num_finished_scan_range(1);
443
0
                _has_prepared_split = false;
444
0
                block->clear_column_data(cast_set<int64_t>(_projected_columns.size()));
445
0
                *eof = false;
446
0
                continue;
447
0
            }
448
0
            if (_should_skip_empty(status, _should_stop || _io_ctx->should_stop)) {
449
                // END_OF_FILE here means the reader discovered a valid split with no data while
450
                // opening or probing it, not that the Scanner has exhausted all splits. Examples
451
                // are a zero-byte CSV with an explicit schema and a Doris Native file containing
452
                // only its 12-byte header. Treat it like V1's empty-file path: finish this range,
453
                // discard partial reader state, and let the loop fetch the next split.
454
0
                RETURN_IF_ERROR(_table_reader->abort_split());
455
0
                COUNTER_UPDATE(_empty_file_counter, 1);
456
0
                _state->update_num_finished_scan_range(1);
457
0
                _has_prepared_split = false;
458
0
                block->clear_column_data(cast_set<int64_t>(_projected_columns.size()));
459
0
                *eof = false;
460
0
                continue;
461
0
            }
462
0
            RETURN_IF_ERROR(status);
463
0
        }
464
0
        if (*eof) {
465
0
            _state->update_num_finished_scan_range(1);
466
0
            _has_prepared_split = false;
467
0
            *eof = false;
468
0
            continue;
469
0
        }
470
0
        _update_adaptive_batch_size(*block);
471
0
        return Status::OK();
472
0
    }
473
0
}
474
475
0
Status FileScannerV2::_filter_output_block(Block* block) {
476
0
    return _contextualize_output_filter_status(Scanner::_filter_output_block(block),
477
0
                                               _get_current_format_type());
478
0
}
479
480
Status FileScannerV2::_contextualize_output_filter_status(Status status,
481
2
                                                          TFileFormatType::type format_type) {
482
2
    if (!status.ok() && format_type == TFileFormatType::FORMAT_ORC) {
483
        // Error-preserving expressions cannot be reordered into the ORC reader and therefore run
484
        // at the scanner boundary; keep their error context identical to ORC callback failures.
485
1
        status.prepend("Orc row reader nextBatch failed. reason = ");
486
1
    }
487
2
    return status;
488
2
}
489
490
0
Status FileScannerV2::_prepare_next_split(bool* eos) {
491
0
    SCOPED_TIMER(_prepare_split_timer);
492
0
    while (true) {
493
0
        bool has_next = _first_scan_range;
494
0
        if (!_first_scan_range) {
495
0
            RETURN_IF_ERROR(_get_next_scan_range(&has_next));
496
0
        }
497
0
        _first_scan_range = false;
498
0
        if (!has_next || _should_stop) {
499
0
            *eos = true;
500
0
            return Status::OK();
501
0
        }
502
0
        DORIS_CHECK(_table_reader != nullptr);
503
0
        _current_range_path = _current_range.path;
504
505
0
        const auto format_type = get_range_format_type(*_params, _current_range);
506
0
        _init_adaptive_batch_size_state(format_type);
507
0
        if (_block_size_predictor != nullptr) {
508
            // JNI readers open eagerly in prepare_split(). Always seed the probe before preparing
509
            // the next split: its metadata-COUNT decision is not available yet, and the state
510
            // exposed by TableReader can still describe the preceding split. Metadata shortcuts
511
            // ignore this batch size, while row-scan fallbacks need it for their first physical
512
            // read batch.
513
0
            _table_reader->set_batch_size(_predict_reader_batch_rows());
514
0
        }
515
0
        std::map<std::string, Field> partition_values;
516
0
        RETURN_IF_ERROR(_generate_partition_values(_current_range, &partition_values));
517
0
        const auto status =
518
0
                _prepare_table_reader_split(_current_range, std::move(partition_values));
519
0
        if (_should_skip_not_found(status, config::ignore_not_found_file_in_external_table)) {
520
0
            RETURN_IF_ERROR(_table_reader->abort_split());
521
0
            COUNTER_UPDATE(_not_found_file_counter, 1);
522
0
            _state->update_num_finished_scan_range(1);
523
0
            continue;
524
0
        }
525
0
        if (_should_skip_empty(status, _should_stop || _io_ctx->should_stop)) {
526
            // Schema discovery can reach EOF before a split becomes prepared. A header-only Native
527
            // file follows this path, while a reader that discovers emptiness on its first
528
            // get_block() follows the symmetric branch in _get_block_impl(). Both paths must
529
            // advance exactly one scan range and preserve later files in the same scan.
530
0
            RETURN_IF_ERROR(_table_reader->abort_split());
531
0
            COUNTER_UPDATE(_empty_file_counter, 1);
532
0
            _state->update_num_finished_scan_range(1);
533
0
            continue;
534
0
        }
535
0
        RETURN_IF_ERROR(status);
536
0
        if (_table_reader->current_split_pruned()) {
537
0
            _state->update_num_finished_scan_range(1);
538
0
            continue;
539
0
        }
540
0
        COUNTER_UPDATE(_file_counter, 1);
541
0
        _has_prepared_split = true;
542
0
        *eos = false;
543
0
        return Status::OK();
544
0
    }
545
0
}
546
547
0
Status FileScannerV2::_init_table_reader(const TFileRangeDesc& range) {
548
0
    const auto format_type = get_range_format_type(*_params, range);
549
0
    format::FileFormat file_format;
550
0
    RETURN_IF_ERROR(_to_file_format(format_type, &file_format));
551
0
    DORIS_CHECK(_table_reader != nullptr);
552
553
0
    VExprContextSPtrs table_conjuncts;
554
0
    RETURN_IF_ERROR(_build_table_conjuncts(&table_conjuncts));
555
0
    std::optional<std::vector<format::GlobalIndex>> push_down_count_columns;
556
0
    const auto& push_down_count_slot_ids = _local_state->get_push_down_count_slot_ids();
557
0
    if (push_down_count_slot_ids.has_value()) {
558
0
        push_down_count_columns.emplace();
559
0
        push_down_count_columns->reserve(push_down_count_slot_ids->size());
560
0
        for (const auto slot_id : *push_down_count_slot_ids) {
561
0
            const auto global_index_it = _slot_id_to_global_index.find(slot_id);
562
0
            if (global_index_it == _slot_id_to_global_index.end()) {
563
0
                return Status::InternalError(
564
0
                        "Pushed-down COUNT argument is not a projected file scan slot, slot_id={}",
565
0
                        slot_id);
566
0
            }
567
0
            push_down_count_columns->push_back(global_index_it->second);
568
0
        }
569
0
    }
570
0
    RETURN_IF_ERROR(_table_reader->init({
571
0
            .projected_columns = _projected_columns,
572
0
            .conjuncts = std::move(table_conjuncts),
573
0
            .format = file_format,
574
0
            .scan_params = const_cast<TFileScanRangeParams*>(_params),
575
0
            .io_ctx = _io_ctx,
576
0
            .runtime_state = _state,
577
0
            .scanner_profile = _local_state->scanner_profile(),
578
0
            .file_slot_descs = &_file_slot_descs,
579
0
            .push_down_agg_type = _local_state->get_push_down_agg_type(),
580
0
            .push_down_count_columns = std::move(push_down_count_columns),
581
0
            .condition_cache_digest = _local_state->get_condition_cache_digest(),
582
0
    }));
583
0
    return Status::OK();
584
0
}
585
586
Status FileScannerV2::_create_table_reader_for_format(
587
0
        const TFileRangeDesc& range, std::unique_ptr<format::TableReader>* reader) const {
588
0
    DORIS_CHECK(reader != nullptr);
589
0
    const auto file_format = get_range_format_type(*_params, range);
590
0
    if (file_format == TFileFormatType::FORMAT_WAL) {
591
0
        *reader = std::make_unique<format::wal::WalTableReader>();
592
0
        return Status::OK();
593
0
    }
594
0
    const auto table_format = table_format_name(range);
595
0
    if (table_format == "NotSet" || table_format == "tvf") {
596
0
        *reader = std::make_unique<format::TableReader>();
597
0
    } else if (table_format == "hive") {
598
0
        *reader = format::hive::HiveReader::create_unique();
599
0
    } else if (table_format == "iceberg") {
600
0
        if (is_iceberg_position_deletes_sys_table(range)) {
601
0
            *reader = std::make_unique<format::iceberg::IcebergPositionDeleteSysTableV2Reader>();
602
0
        } else if (get_range_format_type(*_params, range) == TFileFormatType::FORMAT_JNI) {
603
0
            *reader = std::make_unique<format::iceberg::IcebergSysTableJniReader>();
604
0
        } else {
605
0
            *reader = std::make_unique<format::iceberg::IcebergTableReader>();
606
0
        }
607
0
    } else if (table_format == "paimon") {
608
0
        *reader = std::make_unique<format::paimon::PaimonHybridReader>();
609
0
    } else if (table_format == "hudi") {
610
0
        *reader = std::make_unique<format::hudi::HudiHybridReader>();
611
0
    } else if (table_format == "jdbc") {
612
0
        *reader = std::make_unique<format::jdbc::JdbcJniReader>();
613
0
    } else if (table_format == "max_compute") {
614
0
        const auto* mc_desc =
615
0
                static_cast<const MaxComputeTableDescriptor*>(_output_tuple_desc->table_desc());
616
0
        RETURN_IF_ERROR(mc_desc->init_status());
617
0
        *reader = std::make_unique<format::max_compute::MaxComputeJniReader>(mc_desc);
618
0
    } else if (table_format == "trino_connector") {
619
0
        *reader = std::make_unique<format::trino_connector::TrinoConnectorJniReader>();
620
0
    } else if (table_format == "remote_doris") {
621
0
        *reader = std::make_unique<format::remote_doris::RemoteDorisReader>();
622
0
    } else {
623
0
        return Status::NotSupported("FileScannerV2 does not support table format {}", table_format);
624
0
    }
625
0
    return Status::OK();
626
0
}
627
628
Status FileScannerV2::_prepare_table_reader_split(const TFileRangeDesc& range,
629
0
                                                  std::map<std::string, Field> partition_values) {
630
0
    format::FileFormat current_split_format;
631
0
    RETURN_IF_ERROR(_to_file_format(get_range_format_type(*_params, range), &current_split_format));
632
0
    VExprContextSPtrs conjuncts;
633
0
    RETURN_IF_ERROR(_build_table_conjuncts(&conjuncts));
634
0
    VExprContextSPtrs partition_prune_conjuncts;
635
0
    if (_state->query_options().enable_runtime_filter_partition_prune) {
636
0
        RETURN_IF_ERROR(_build_table_conjuncts(&partition_prune_conjuncts));
637
0
    }
638
0
    RETURN_IF_ERROR(_table_reader->prepare_split({
639
0
            .partition_values = std::move(partition_values),
640
0
            .conjuncts = std::move(conjuncts),
641
0
            .partition_prune_conjuncts = std::move(partition_prune_conjuncts),
642
            // A metadata COUNT split may span scheduler turns. Do not enter that irreversible
643
            // synthetic-row path while a runtime filter can still arrive between batches.
644
0
            .all_runtime_filters_applied = _applied_rf_num == _total_rf_num,
645
0
            .condition_cache_digest = _current_condition_cache_digest(),
646
0
            .cache = _kv_cache,
647
0
            .current_range = range,
648
0
            .current_split_format = current_split_format,
649
0
            .global_rowid_context = _create_global_rowid_context(range),
650
0
    }));
651
0
    return Status::OK();
652
0
}
653
654
4
bool FileScannerV2::_should_skip_not_found(const Status& status, bool ignore_not_found) {
655
4
    return ignore_not_found && status.is<ErrorCode::NOT_FOUND>();
656
4
}
657
658
4
bool FileScannerV2::_should_skip_empty(const Status& status, bool stopped) {
659
    // Several readers use END_OF_FILE both for a valid zero-row split and for an interrupted IO.
660
    // For example, DeletionVectorReader returns END_OF_FILE("stop read.") after try_stop() marks
661
    // the shared IOContext. That status must unwind the stopped scanner; counting it as an empty
662
    // file would incorrectly finish the scan range and increment EmptyFileNum.
663
4
    return !stopped && status.is<ErrorCode::END_OF_FILE>();
664
4
}
665
666
0
bool FileScannerV2::_should_enable_file_meta_cache() const {
667
0
    return ExecEnv::GetInstance()->file_meta_cache()->enabled() &&
668
0
           _split_source->num_scan_ranges() < config::max_external_file_meta_cache_num / 3;
669
0
}
670
671
std::optional<format::GlobalRowIdContext> FileScannerV2::_create_global_rowid_context(
672
0
        const TFileRangeDesc& range) const {
673
0
    if (!_need_global_rowid_column) {
674
0
        return std::nullopt;
675
0
    }
676
0
    auto& id_file_map = _state->get_id_file_map();
677
0
    DORIS_CHECK(id_file_map != nullptr);
678
0
    const auto file_id = id_file_map->get_file_mapping_id(
679
0
            std::make_shared<FileMapping>(_local_state->cast<FileScanLocalState>().parent_id(),
680
0
                                          range, _should_enable_file_meta_cache()));
681
0
    return format::GlobalRowIdContext {
682
0
            .version = IdManager::ID_VERSION,
683
0
            .backend_id = BackendOptions::get_backend_id(),
684
0
            .file_id = file_id,
685
0
    };
686
0
}
687
688
Status FileScannerV2::_generate_partition_values(
689
0
        const TFileRangeDesc& range, std::map<std::string, Field>* partition_values) const {
690
0
    DORIS_CHECK(partition_values != nullptr);
691
0
    partition_values->clear();
692
0
    if (!range.__isset.columns_from_path_keys || !range.__isset.columns_from_path) {
693
0
        return Status::OK();
694
0
    }
695
0
    DORIS_CHECK(range.columns_from_path_keys.size() == range.columns_from_path.size());
696
0
    for (size_t idx = 0; idx < range.columns_from_path_keys.size(); ++idx) {
697
0
        const auto& key = range.columns_from_path_keys[idx];
698
0
        const auto it = _partition_slot_descs.find(key);
699
0
        if (it == _partition_slot_descs.end()) {
700
0
            continue;
701
0
        }
702
0
        const auto& value = range.columns_from_path[idx];
703
0
        const bool is_null = range.__isset.columns_from_path_is_null &&
704
0
                             idx < range.columns_from_path_is_null.size() &&
705
0
                             range.columns_from_path_is_null[idx];
706
0
        Field field;
707
0
        DORIS_CHECK(it->second.slot_desc != nullptr);
708
0
        RETURN_IF_ERROR(_parse_partition_value(it->second.slot_desc, value, is_null, &field));
709
0
        partition_values->emplace(it->second.canonical_name, std::move(field));
710
0
    }
711
0
    return Status::OK();
712
0
}
713
714
Status FileScannerV2::_parse_partition_value(const SlotDescriptor* slot_desc,
715
                                             const std::string& value, bool is_null,
716
0
                                             Field* field) const {
717
0
    DORIS_CHECK(slot_desc != nullptr);
718
0
    DORIS_CHECK(field != nullptr);
719
0
    if (is_null) {
720
0
        *field = Field::create_field<TYPE_NULL>(Null());
721
0
        return Status::OK();
722
0
    }
723
0
    const auto data_type = remove_nullable(slot_desc->get_data_type_ptr());
724
0
    auto column = data_type->create_column();
725
0
    auto serde = data_type->get_serde();
726
0
    DataTypeSerDe::FormatOptions options;
727
0
    options.converted_from_string = true;
728
0
    StringRef ref(value.data(), value.size());
729
0
    RETURN_IF_ERROR(serde->from_string(ref, *column, options));
730
0
    DORIS_CHECK(column->size() == 1);
731
0
    *field = (*column)[0];
732
0
    return Status::OK();
733
0
}
734
735
0
Status FileScannerV2::_init_expr_ctxes() {
736
0
    _slot_id_to_desc.clear();
737
0
    _slot_id_to_global_index.clear();
738
0
    _partition_slot_descs.clear();
739
0
    _file_slot_descs.clear();
740
0
    for (const auto* slot_desc : _output_tuple_desc->slots()) {
741
0
        _slot_id_to_desc.emplace(slot_desc->id(), slot_desc);
742
0
    }
743
0
    DORIS_CHECK(_table_reader != nullptr);
744
0
    RETURN_IF_ERROR(_build_projected_columns(*_table_reader));
745
0
    return Status::OK();
746
0
}
747
748
0
Status FileScannerV2::_build_projected_columns(const format::TableReader& table_reader) {
749
0
    _projected_columns.clear();
750
0
    _projected_columns.reserve(_params->required_slots.size());
751
0
    _need_global_rowid_column = false;
752
0
    format::ProjectedColumnBuildContext build_context {
753
0
            .scan_params = _params,
754
0
            .range = &_current_range,
755
0
            .runtime_state = _state,
756
0
    };
757
    // Field 34 is the rollout boundary for root and nested exact-name precedence.
758
0
    const bool prefer_exact_name_match =
759
0
            !_params->__isset.history_schema_info || supports_iceberg_scan_semantics_v1(_params);
760
761
0
    for (size_t slot_idx = 0; slot_idx < _params->required_slots.size(); ++slot_idx) {
762
0
        const auto& slot_info = _params->required_slots[slot_idx];
763
0
        const auto it = _slot_id_to_desc.find(slot_info.slot_id);
764
0
        if (it == _slot_id_to_desc.end()) {
765
0
            return Status::InternalError("Unknown source slot descriptor, slot_id={}",
766
0
                                         slot_info.slot_id);
767
0
        }
768
0
        auto column = _build_table_column(it->second);
769
0
        build_context.slot_desc = it->second;
770
0
        if (column.name.starts_with(BeConsts::GLOBAL_ROWID_COL)) {
771
0
            _need_global_rowid_column = true;
772
0
        }
773
0
        RETURN_IF_ERROR(_build_default_expr(slot_info, &column.default_expr));
774
0
        build_context.schema_column.reset();
775
0
        RETURN_IF_ERROR(table_reader.annotate_projected_column(slot_info, &build_context, &column));
776
        // Build nested children from access paths generated by the slot's access-path
777
        // expressions. A projected column can therefore contain only a subset of the schema
778
        // column's nested children.
779
0
        RETURN_IF_ERROR(AccessPathParser::build_nested_children(
780
0
                &column, it->second,
781
0
                build_context.schema_column.has_value() ? &*build_context.schema_column : nullptr,
782
0
                prefer_exact_name_match));
783
0
        if (is_partition_slot(slot_info, column.name)) {
784
0
            column.is_partition_key = true;
785
0
            _partition_slot_descs.emplace(
786
0
                    column.name,
787
0
                    PartitionSlotInfo {.slot_desc = it->second, .canonical_name = column.name});
788
0
            for (const auto& alias : column.name_mapping) {
789
0
                _partition_slot_descs.emplace(
790
0
                        alias,
791
0
                        PartitionSlotInfo {.slot_desc = it->second, .canonical_name = column.name});
792
0
            }
793
0
        } else if (is_data_file_slot(slot_info, column.name)) {
794
0
            _file_slot_descs.push_back(const_cast<SlotDescriptor*>(it->second));
795
0
        }
796
0
        const auto global_index = format::GlobalIndex(slot_idx);
797
0
        _slot_id_to_global_index.emplace(slot_info.slot_id, global_index);
798
0
        _projected_columns.push_back(std::move(column));
799
0
    }
800
0
    RETURN_IF_ERROR(table_reader.validate_projected_columns(build_context));
801
0
    return Status::OK();
802
0
}
803
804
Status FileScannerV2::_build_default_expr(const TFileScanSlotInfo& slot_info,
805
0
                                          VExprContextSPtr* ctx) const {
806
0
    DORIS_CHECK(ctx != nullptr);
807
0
    if (slot_info.__isset.default_value_expr && !slot_info.default_value_expr.nodes.empty()) {
808
0
        return VExpr::create_expr_tree(slot_info.default_value_expr, *ctx);
809
0
    }
810
811
0
    if (_params->__isset.default_value_of_src_slot) {
812
0
        const auto it = _params->default_value_of_src_slot.find(slot_info.slot_id);
813
0
        if (it != _params->default_value_of_src_slot.end() && !it->second.nodes.empty()) {
814
0
            return VExpr::create_expr_tree(it->second, *ctx);
815
0
        }
816
0
    }
817
0
    return Status::OK();
818
0
}
819
820
0
format::ColumnDefinition FileScannerV2::_build_table_column(const SlotDescriptor* slot_desc) {
821
0
    DORIS_CHECK(slot_desc != nullptr);
822
0
    format::ColumnDefinition column;
823
    // TODO(gabriel): why always BY_NAME here?
824
0
    column.identifier = Field::create_field<TYPE_STRING>(slot_desc->col_name());
825
0
    column.name = slot_desc->col_name();
826
0
    column.type = slot_desc->get_data_type_ptr();
827
0
    return column;
828
0
}
829
830
0
Status FileScannerV2::_build_table_conjuncts(VExprContextSPtrs* conjuncts) const {
831
0
    DORIS_CHECK(conjuncts != nullptr);
832
0
    conjuncts->clear();
833
0
    conjuncts->reserve(_conjuncts.size());
834
0
    for (const auto& conjunct : _conjuncts) {
835
0
        VExprSPtr root;
836
0
        RETURN_IF_ERROR(format::clone_table_expr_tree(conjunct->root(), &root));
837
0
        RETURN_IF_ERROR(rewrite_slot_refs_to_global_index(&root, _slot_id_to_global_index));
838
0
        conjuncts->push_back(VExprContext::create_shared(std::move(root)));
839
0
    }
840
0
    return Status::OK();
841
0
}
842
843
0
TFileFormatType::type FileScannerV2::_get_current_format_type() const {
844
0
    return get_range_format_type(*_params, _current_range);
845
0
}
846
847
Status FileScannerV2::_to_file_format(TFileFormatType::type format_type,
848
17
                                      format::FileFormat* file_format) {
849
17
    DORIS_CHECK(file_format != nullptr);
850
17
    switch (format_type) {
851
1
    case TFileFormatType::FORMAT_PARQUET:
852
1
        *file_format = format::FileFormat::PARQUET;
853
1
        return Status::OK();
854
1
    case TFileFormatType::FORMAT_ORC:
855
1
        *file_format = format::FileFormat::ORC;
856
1
        return Status::OK();
857
1
    case TFileFormatType::FORMAT_JNI:
858
1
        *file_format = format::FileFormat::JNI;
859
1
        return Status::OK();
860
1
    case TFileFormatType::FORMAT_CSV_PLAIN:
861
2
    case TFileFormatType::FORMAT_CSV_GZ:
862
3
    case TFileFormatType::FORMAT_CSV_BZ2:
863
4
    case TFileFormatType::FORMAT_CSV_LZ4FRAME:
864
5
    case TFileFormatType::FORMAT_CSV_LZ4BLOCK:
865
6
    case TFileFormatType::FORMAT_CSV_LZOP:
866
7
    case TFileFormatType::FORMAT_CSV_DEFLATE:
867
8
    case TFileFormatType::FORMAT_CSV_SNAPPYBLOCK:
868
9
    case TFileFormatType::FORMAT_PROTO:
869
9
        *file_format = format::FileFormat::CSV;
870
9
        return Status::OK();
871
1
    case TFileFormatType::FORMAT_TEXT:
872
1
        *file_format = format::FileFormat::TEXT;
873
1
        return Status::OK();
874
1
    case TFileFormatType::FORMAT_JSON:
875
1
        *file_format = format::FileFormat::JSON;
876
1
        return Status::OK();
877
1
    case TFileFormatType::FORMAT_NATIVE:
878
1
        *file_format = format::FileFormat::NATIVE;
879
1
        return Status::OK();
880
1
    case TFileFormatType::FORMAT_ARROW:
881
1
        *file_format = format::FileFormat::ARROW;
882
1
        return Status::OK();
883
1
    case TFileFormatType::FORMAT_WAL:
884
1
        *file_format = format::FileFormat::WAL;
885
1
        return Status::OK();
886
0
    default:
887
0
        return Status::NotSupported("FileScannerV2 does not support file format {}",
888
0
                                    to_string(format_type));
889
17
    }
890
17
}
891
892
0
Status FileScannerV2::_init_io_ctx() {
893
0
    _io_ctx = create_file_scan_io_context(_state);
894
0
    return Status::OK();
895
0
}
896
897
0
void FileScannerV2::_reset_adaptive_batch_size_state() {
898
0
    _block_size_predictor.reset();
899
0
    COUNTER_SET(_adaptive_batch_predicted_rows_counter, int64_t(0));
900
0
    COUNTER_SET(_adaptive_batch_actual_bytes_counter, int64_t(0));
901
0
}
902
903
0
void FileScannerV2::_init_adaptive_batch_size_state(TFileFormatType::type format_type) {
904
0
    _reset_adaptive_batch_size_state();
905
0
    if (!_should_enable_adaptive_batch_size(format_type)) {
906
0
        return;
907
0
    }
908
909
    // V2 native file readers do not have reliable row-width hints before the first batch. Start
910
    // every split with a small probe, then learn bytes-per-row from the materialized table block
911
    // and keep later batches close to RuntimeState::preferred_block_size_bytes().
912
0
    _block_size_predictor = std::make_unique<AdaptiveBlockSizePredictor>(
913
0
            _state->preferred_block_size_bytes(), 0.0, ADAPTIVE_BATCH_INITIAL_PROBE_ROWS,
914
0
            _state->batch_size());
915
0
}
916
917
0
bool FileScannerV2::_should_enable_adaptive_batch_size(TFileFormatType::type format_type) const {
918
0
    if (!config::enable_adaptive_batch_size) {
919
0
        return false;
920
0
    }
921
0
    switch (format_type) {
922
0
    case TFileFormatType::FORMAT_PARQUET:
923
0
    case TFileFormatType::FORMAT_ORC:
924
0
    case TFileFormatType::FORMAT_CSV_PLAIN:
925
0
    case TFileFormatType::FORMAT_CSV_GZ:
926
0
    case TFileFormatType::FORMAT_CSV_BZ2:
927
0
    case TFileFormatType::FORMAT_CSV_LZ4FRAME:
928
0
    case TFileFormatType::FORMAT_CSV_LZ4BLOCK:
929
0
    case TFileFormatType::FORMAT_CSV_LZOP:
930
0
    case TFileFormatType::FORMAT_CSV_DEFLATE:
931
0
    case TFileFormatType::FORMAT_CSV_SNAPPYBLOCK:
932
0
    case TFileFormatType::FORMAT_PROTO:
933
0
    case TFileFormatType::FORMAT_TEXT:
934
0
    case TFileFormatType::FORMAT_JSON:
935
0
    case TFileFormatType::FORMAT_JNI:
936
0
        return true;
937
0
    default:
938
0
        return false;
939
0
    }
940
0
}
941
942
0
bool FileScannerV2::_should_run_adaptive_batch_size() const {
943
0
    DORIS_CHECK(_table_reader != nullptr);
944
0
    return _should_run_adaptive_batch_size(_block_size_predictor != nullptr,
945
0
                                           _table_reader->current_split_uses_metadata_count());
946
0
}
947
948
bool FileScannerV2::_should_run_adaptive_batch_size(bool predictor_initialized,
949
3
                                                    bool current_split_uses_metadata_count) {
950
    // Metadata COUNT emits synthetic rows and has no physical row width to learn from. A raw COUNT
951
    // opcode is not sufficient here: unsupported argument counts, mappings, filters, or deletes
952
    // make TableReader fall back to materializing normal rows, which still need adaptive batching.
953
3
    return predictor_initialized && !current_split_uses_metadata_count;
954
3
}
955
956
0
size_t FileScannerV2::_predict_reader_batch_rows() {
957
0
    DORIS_CHECK(_block_size_predictor != nullptr);
958
    // Before history exists this returns the probe row count; after update(), it returns roughly
959
    // preferred_block_size_bytes / EWMA(bytes_per_row), capped by RuntimeState::batch_size().
960
0
    const size_t predicted_rows = _block_size_predictor->predict_next_rows();
961
0
    COUNTER_SET(_adaptive_batch_predicted_rows_counter, static_cast<int64_t>(predicted_rows));
962
0
    return predicted_rows;
963
0
}
964
965
0
void FileScannerV2::_update_adaptive_batch_size(const Block& block) {
966
0
    if (!_should_run_adaptive_batch_size()) {
967
0
        return;
968
0
    }
969
0
    COUNTER_SET(_adaptive_batch_actual_bytes_counter, static_cast<int64_t>(block.bytes()));
970
0
    if (block.rows() == 0) {
971
0
        return;
972
0
    }
973
    // The sample is taken after TableReader has finalized file-local columns to table columns.
974
    // This matches the memory shape seen by upstream operators and catches very wide nested
975
    // columns, such as map/string payloads, after the first probe batch.
976
0
    if (!_block_size_predictor->has_history()) {
977
0
        COUNTER_UPDATE(_adaptive_batch_probe_count_counter, 1);
978
0
    }
979
0
    _block_size_predictor->update(block);
980
0
}
981
982
3
Status FileScannerV2::close(RuntimeState* state) {
983
3
    SCOPED_TIMER(_scanner_total_timer);
984
3
    SCOPED_TIMER(_close_timer);
985
3
    if (!_try_close()) {
986
1
        return Status::OK();
987
1
    }
988
2
    if (_table_reader != nullptr) {
989
2
        const auto close_status = _table_reader->close();
990
2
        if (!close_status.ok()) {
991
            // Reserve the close attempt with _try_close(), but commit the scanner-level closed
992
            // state only after the retained table reader has completed its retryable cleanup.
993
1
            _is_closed.store(false);
994
1
            return close_status;
995
1
        }
996
1
        _report_condition_cache_profile();
997
1
        _table_reader.reset();
998
1
    }
999
1
    return Scanner::close(state);
1000
2
}
1001
1002
0
void FileScannerV2::try_stop() {
1003
0
    Scanner::try_stop();
1004
0
    if (_io_ctx) {
1005
0
        _io_ctx->should_stop = true;
1006
0
    }
1007
0
}
1008
1009
0
void FileScannerV2::update_realtime_counters() {
1010
0
    if (_file_reader_stats == nullptr) {
1011
0
        return;
1012
0
    }
1013
0
    DORIS_CHECK(_file_cache_statistics != nullptr);
1014
0
    const int64_t bytes_read = cast_set<int64_t>(_file_reader_stats->read_bytes);
1015
0
    auto* local_state = static_cast<FileScanLocalState*>(_local_state);
1016
0
    const auto file_type =
1017
0
            _current_range.__isset.file_type
1018
0
                    ? _current_range.file_type
1019
0
                    : (_params != nullptr && _params->__isset.file_type ? _params->file_type
1020
0
                                                                        : TFileType::FILE_LOCAL);
1021
0
    const auto deltas = _collect_realtime_counter_deltas(
1022
0
            *_file_reader_stats, *_file_cache_statistics, _uncached_reader_bytes_storage(file_type),
1023
0
            &_last_read_bytes, &_last_read_rows, &_last_bytes_read_from_local,
1024
0
            &_last_bytes_read_from_remote);
1025
1026
0
    COUNTER_UPDATE(local_state->_scan_bytes, deltas.scan_bytes);
1027
0
    COUNTER_UPDATE(local_state->_scan_rows, deltas.scan_rows);
1028
1029
0
    _state->get_query_ctx()->resource_ctx()->io_context()->update_scan_rows(deltas.scan_rows);
1030
0
    _state->get_query_ctx()->resource_ctx()->io_context()->update_scan_bytes(deltas.scan_bytes);
1031
0
    _state->get_query_ctx()->resource_ctx()->io_context()->update_scan_bytes_from_local_storage(
1032
0
            deltas.scan_bytes_from_local_storage);
1033
0
    _state->get_query_ctx()->resource_ctx()->io_context()->update_scan_bytes_from_remote_storage(
1034
0
            deltas.scan_bytes_from_remote_storage);
1035
1036
0
    COUNTER_SET(_file_read_bytes_counter, bytes_read);
1037
0
    COUNTER_SET(_file_read_calls_counter, cast_set<int64_t>(_file_reader_stats->read_calls));
1038
0
    COUNTER_SET(_file_read_time_counter, cast_set<int64_t>(_file_reader_stats->read_time_ns));
1039
1040
0
    DorisMetrics::instance()->query_scan_bytes->increment(deltas.scan_bytes);
1041
0
    DorisMetrics::instance()->query_scan_rows->increment(deltas.scan_rows);
1042
0
    DorisMetrics::instance()->query_scan_bytes_from_local->increment(
1043
0
            deltas.scan_bytes_from_local_storage);
1044
0
    DorisMetrics::instance()->query_scan_bytes_from_remote->increment(
1045
0
            deltas.scan_bytes_from_remote_storage);
1046
0
}
1047
1048
FileScannerV2::RealtimeCounterDeltas FileScannerV2::_collect_realtime_counter_deltas(
1049
        const io::FileReaderStats& file_reader_stats,
1050
        const io::FileCacheStatistics& file_cache_statistics,
1051
        UncachedReaderBytesStorage uncached_reader_bytes_storage, int64_t* last_read_bytes,
1052
        int64_t* last_read_rows, int64_t* last_bytes_read_from_local,
1053
7
        int64_t* last_bytes_read_from_remote) {
1054
7
    DORIS_CHECK(last_read_bytes != nullptr);
1055
7
    DORIS_CHECK(last_read_rows != nullptr);
1056
7
    DORIS_CHECK(last_bytes_read_from_local != nullptr);
1057
7
    DORIS_CHECK(last_bytes_read_from_remote != nullptr);
1058
1059
7
    const int64_t read_bytes = cast_set<int64_t>(file_reader_stats.read_bytes);
1060
7
    const int64_t read_rows = cast_set<int64_t>(file_reader_stats.read_rows);
1061
7
    const int64_t bytes_read_from_local = file_cache_statistics.bytes_read_from_local;
1062
7
    const int64_t bytes_read_from_remote = file_cache_statistics.bytes_read_from_remote;
1063
7
    DORIS_CHECK(read_bytes >= *last_read_bytes);
1064
7
    DORIS_CHECK(read_rows >= *last_read_rows);
1065
7
    DORIS_CHECK(bytes_read_from_local >= *last_bytes_read_from_local);
1066
7
    DORIS_CHECK(bytes_read_from_remote >= *last_bytes_read_from_remote);
1067
1068
7
    RealtimeCounterDeltas deltas;
1069
7
    deltas.scan_rows = read_rows - *last_read_rows;
1070
7
    deltas.scan_bytes = read_bytes - *last_read_bytes;
1071
    // Peer cache is a known cache source, but it is not remote object storage.
1072
7
    const bool has_cache_source_stats = file_cache_statistics.num_local_io_total != 0 ||
1073
7
                                        file_cache_statistics.num_remote_io_total != 0 ||
1074
7
                                        file_cache_statistics.num_peer_io_total != 0 ||
1075
7
                                        bytes_read_from_local != 0 || bytes_read_from_remote != 0 ||
1076
7
                                        file_cache_statistics.bytes_read_from_peer != 0;
1077
7
    if (!has_cache_source_stats) {
1078
4
        switch (uncached_reader_bytes_storage) {
1079
1
        case UncachedReaderBytesStorage::LOCAL:
1080
1
            deltas.scan_bytes_from_local_storage = deltas.scan_bytes;
1081
1
            break;
1082
3
        case UncachedReaderBytesStorage::REMOTE:
1083
3
            deltas.scan_bytes_from_remote_storage = deltas.scan_bytes;
1084
3
            break;
1085
0
        case UncachedReaderBytesStorage::NONE:
1086
0
            break;
1087
4
        }
1088
4
    } else {
1089
3
        deltas.scan_bytes_from_local_storage = bytes_read_from_local - *last_bytes_read_from_local;
1090
3
        deltas.scan_bytes_from_remote_storage =
1091
3
                bytes_read_from_remote - *last_bytes_read_from_remote;
1092
3
    }
1093
1094
7
    *last_read_bytes = read_bytes;
1095
7
    *last_read_rows = read_rows;
1096
7
    *last_bytes_read_from_local = bytes_read_from_local;
1097
7
    *last_bytes_read_from_remote = bytes_read_from_remote;
1098
7
    return deltas;
1099
7
}
1100
1101
FileScannerV2::UncachedReaderBytesStorage FileScannerV2::_uncached_reader_bytes_storage(
1102
0
        TFileType::type file_type) {
1103
0
    switch (file_type) {
1104
0
    case TFileType::FILE_LOCAL:
1105
0
        return UncachedReaderBytesStorage::LOCAL;
1106
0
    case TFileType::FILE_STREAM:
1107
0
        return UncachedReaderBytesStorage::NONE;
1108
0
    case TFileType::FILE_BROKER:
1109
0
    case TFileType::FILE_S3:
1110
0
    case TFileType::FILE_HDFS:
1111
0
    case TFileType::FILE_NET:
1112
0
    case TFileType::FILE_HTTP:
1113
0
        return UncachedReaderBytesStorage::REMOTE;
1114
0
    }
1115
0
    DORIS_CHECK(false) << "unknown file type: " << file_type;
1116
0
    return UncachedReaderBytesStorage::NONE;
1117
0
}
1118
1119
0
void FileScannerV2::_collect_profile_before_close() {
1120
0
    _report_file_reader_predicate_filtered_rows();
1121
0
    Scanner::_collect_profile_before_close();
1122
0
    if (config::enable_file_cache && _state->query_options().enable_file_cache &&
1123
0
        _profile != nullptr) {
1124
0
        auto file_cache_delta = io::diff_file_cache_statistics(*_file_cache_statistics,
1125
0
                                                               _reported_file_cache_statistics);
1126
        // Profile collection can run more than once. Keep additive fields incremental while
1127
        // publishing high-water gauges and peer identities from the latest complete snapshot.
1128
0
        file_cache_delta.remote_only_on_miss_triggered =
1129
0
                _file_cache_statistics->remote_only_on_miss_triggered;
1130
0
        file_cache_delta.remote_only_on_miss_threshold_bytes =
1131
0
                _file_cache_statistics->remote_only_on_miss_threshold_bytes;
1132
0
        file_cache_delta.peer_hosts = _file_cache_statistics->peer_hosts;
1133
0
        _report_file_cache_profile(_profile, file_cache_delta);
1134
0
        _state->get_query_ctx()->resource_ctx()->io_context()->update_bytes_write_into_cache(
1135
0
                file_cache_delta.bytes_write_into_cache);
1136
0
        _reported_file_cache_statistics = *_file_cache_statistics;
1137
0
    }
1138
0
    if (_file_reader_stats != nullptr) {
1139
0
        COUNTER_SET(_file_read_bytes_counter, cast_set<int64_t>(_file_reader_stats->read_bytes));
1140
0
        COUNTER_SET(_file_read_calls_counter, cast_set<int64_t>(_file_reader_stats->read_calls));
1141
0
        COUNTER_SET(_file_read_time_counter, cast_set<int64_t>(_file_reader_stats->read_time_ns));
1142
0
        const auto read_time = cast_set<int64_t>(_file_reader_stats->read_time_ns);
1143
0
        DORIS_CHECK(read_time >= _reported_io_read_time);
1144
        // Some transports (for example Arrow Flight) record directly into IO, while filesystem
1145
        // reads arrive through FileReaderStats. Add only the new traced delta so both paths remain
1146
        // visible without double counting repeated profile publication.
1147
0
        COUNTER_UPDATE(_io_timer, read_time - _reported_io_read_time);
1148
0
        _reported_io_read_time = read_time;
1149
0
    }
1150
    // Query profiles can be collected before Scanner::close() runs. Publish condition-cache
1151
    // counters here as well, using deltas so this method and close() cannot double count.
1152
0
    _report_condition_cache_profile();
1153
0
}
1154
1155
void FileScannerV2::_report_file_cache_profile(
1156
1
        RuntimeProfile* profile, const io::FileCacheStatistics& file_cache_statistics) {
1157
1
    file_scan_profile::ensure_hierarchy(profile);
1158
1
    io::FileCacheProfileReporter cache_profile(profile, file_scan_profile::IO);
1159
1
    cache_profile.update(&file_cache_statistics);
1160
1
}
1161
1162
0
bool FileScannerV2::_should_update_load_counters() const {
1163
0
    if (_is_load) {
1164
0
        return true;
1165
0
    }
1166
    // TVF based loads (e.g. http_stream, group commit relay) plan the load source as a
1167
    // tvf query scan without src tuple desc, so _is_load is false. But rows filtered by
1168
    // the load's WHERE clause still need to be reported as unselected rows. FILE_STREAM
1169
    // is only reachable from such load entries, never from normal queries, so use it to
1170
    // identify these scanners.
1171
0
    return (_params != nullptr && _params->__isset.file_type &&
1172
0
            _params->file_type == TFileType::FILE_STREAM) ||
1173
0
           (_current_range.__isset.file_type && _current_range.file_type == TFileType::FILE_STREAM);
1174
0
}
1175
1176
0
void FileScannerV2::_report_file_reader_predicate_filtered_rows() {
1177
0
    const int64_t filtered_rows = _io_ctx != nullptr ? _io_ctx->predicate_filtered_rows : 0;
1178
0
    const int64_t filtered_delta = filtered_rows - _reported_predicate_filtered_rows;
1179
0
    if (filtered_delta > 0) {
1180
        // File readers can evaluate localized conjuncts before a block reaches Scanner. Count
1181
        // those rows as scanner-level unselected rows so load statistics stay identical no matter
1182
        // whether a predicate is pushed down or evaluated by Scanner::_filter_output_block().
1183
0
        _counter.num_rows_unselected += filtered_delta;
1184
0
        _reported_predicate_filtered_rows = filtered_rows;
1185
0
    }
1186
0
}
1187
1188
1
void FileScannerV2::_report_condition_cache_profile() {
1189
1
    auto* local_state = static_cast<FileScanLocalState*>(_local_state);
1190
1
    const int64_t hit_count =
1191
1
            _table_reader != nullptr ? _table_reader->condition_cache_hit_count() : 0;
1192
1
    const int64_t hit_delta = hit_count - _reported_condition_cache_hit_count;
1193
1
    if (hit_delta > 0) {
1194
0
        COUNTER_UPDATE(local_state->_condition_cache_hit_counter, hit_delta);
1195
0
        _reported_condition_cache_hit_count = hit_count;
1196
0
    }
1197
1
    const int64_t filtered_rows = _io_ctx != nullptr ? _io_ctx->condition_cache_filtered_rows : 0;
1198
1
    const int64_t filtered_delta = filtered_rows - _reported_condition_cache_filtered_rows;
1199
1
    if (filtered_delta > 0) {
1200
0
        COUNTER_UPDATE(local_state->_condition_cache_filtered_rows_counter, filtered_delta);
1201
0
        _reported_condition_cache_filtered_rows = filtered_rows;
1202
0
    }
1203
1
}
1204
1205
} // namespace doris