be/src/vec/exec/format/table/paimon_reader.h

// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License.  You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied.  See the License for the
// specific language governing permissions and limitations
// under the License.

#pragma once

#include <memory>
#include <vector>

#include "vec/exec/format/orc/vorc_reader.h"
#include "vec/exec/format/parquet/vparquet_reader.h"
#include "vec/exec/format/table/table_format_reader.h"

namespace doris::vectorized {
#include "common/compile_check_begin.h"
class PaimonReader : public TableFormatReader, public TableSchemaChangeHelper {
public:
    PaimonReader(std::unique_ptr<GenericReader> file_format_reader, RuntimeProfile* profile,
                 RuntimeState* state, const TFileScanRangeParams& params,
                 const TFileRangeDesc& range, ShardedKVCache* kv_cache, io::IOContext* io_ctx,
                 FileMetaCache* meta_cache);

    ~PaimonReader() override = default;

    Status init_row_filters() final;

    Status get_next_block_inner(Block* block, size_t* read_rows, bool* eof) final;

protected:
    struct PaimonProfile {
        RuntimeProfile::Counter* num_delete_rows;
        RuntimeProfile::Counter* delete_files_read_time;
        RuntimeProfile::Counter* parse_deletion_vector_time;
    };
    // _delete_rows from kv_cache.
    const std::vector<int64_t>* _delete_rows = nullptr;
    // owned by scan node
    ShardedKVCache* _kv_cache;
    PaimonProfile _paimon_profile;

    virtual void set_delete_rows() = 0;
};

class PaimonOrcReader final : public PaimonReader {
public:
    ENABLE_FACTORY_CREATOR(PaimonOrcReader);
    PaimonOrcReader(std::unique_ptr<GenericReader> file_format_reader, RuntimeProfile* profile,
                    RuntimeState* state, const TFileScanRangeParams& params,
                    const TFileRangeDesc& range, ShardedKVCache* kv_cache, io::IOContext* io_ctx,
                    FileMetaCache* meta_cache)
            : PaimonReader(std::move(file_format_reader), profile, state, params, range, kv_cache,
                           io_ctx, meta_cache) {};
    ~PaimonOrcReader() final = default;

    void set_delete_rows() final {
        (reinterpret_cast<OrcReader*>(_file_format_reader.get()))
                ->set_position_delete_rowids(_delete_rows);
    }

    Status init_reader(
            const std::vector<std::string>& read_table_col_names,
            std::unordered_map<std::string, uint32_t>* col_name_to_block_idx,
            const VExprContextSPtrs& conjuncts, const TupleDescriptor* tuple_descriptor,
            const RowDescriptor* row_descriptor,
            const VExprContextSPtrs* not_single_slot_filter_conjuncts,
            const std::unordered_map<int, VExprContextSPtrs>* slot_id_to_filter_conjuncts) {
        auto* orc_reader = static_cast<OrcReader*>(_file_format_reader.get());
        const orc::Type* orc_type_ptr = nullptr;
        RETURN_IF_ERROR(orc_reader->get_file_type(&orc_type_ptr));
        RETURN_IF_ERROR(gen_table_info_node_by_field_id(
                _params, _range.table_format_params.paimon_params.schema_id, tuple_descriptor,
                orc_type_ptr));

        return orc_reader->init_reader(&read_table_col_names, col_name_to_block_idx, conjuncts,
                                       false, tuple_descriptor, row_descriptor,
                                       not_single_slot_filter_conjuncts,
                                       slot_id_to_filter_conjuncts, table_info_node_ptr);
    }
};

class PaimonParquetReader final : public PaimonReader {
public:
    ENABLE_FACTORY_CREATOR(PaimonParquetReader);
    PaimonParquetReader(std::unique_ptr<GenericReader> file_format_reader, RuntimeProfile* profile,
                        RuntimeState* state, const TFileScanRangeParams& params,
                        const TFileRangeDesc& range, ShardedKVCache* kv_cache,
                        io::IOContext* io_ctx, FileMetaCache* meta_cache)
            : PaimonReader(std::move(file_format_reader), profile, state, params, range, kv_cache,
                           io_ctx, meta_cache) {};
    ~PaimonParquetReader() final = default;

    void set_delete_rows() final {
        (reinterpret_cast<ParquetReader*>(_file_format_reader.get()))
                ->set_delete_rows(_delete_rows);
    }

    Status init_reader(
            const std::vector<std::string>& read_table_col_names,
            std::unordered_map<std::string, uint32_t>* col_name_to_block_idx,
            const VExprContextSPtrs& conjuncts,
            phmap::flat_hash_map<int, std::vector<std::shared_ptr<ColumnPredicate>>>&
                    slot_id_to_predicates,
            const TupleDescriptor* tuple_descriptor, const RowDescriptor* row_descriptor,
            const std::unordered_map<std::string, int>* colname_to_slot_id,
            const VExprContextSPtrs* not_single_slot_filter_conjuncts,
            const std::unordered_map<int, VExprContextSPtrs>* slot_id_to_filter_conjuncts) {
        auto* parquet_reader = static_cast<ParquetReader*>(_file_format_reader.get());

        const FieldDescriptor* field_desc = nullptr;
        RETURN_IF_ERROR(parquet_reader->get_file_metadata_schema(&field_desc));
        DCHECK(field_desc != nullptr);

        RETURN_IF_ERROR(gen_table_info_node_by_field_id(
                _params, _range.table_format_params.paimon_params.schema_id, tuple_descriptor,
                *field_desc));

        return parquet_reader->init_reader(read_table_col_names, col_name_to_block_idx, conjuncts,
                                           slot_id_to_predicates, tuple_descriptor, row_descriptor,
                                           colname_to_slot_id, not_single_slot_filter_conjuncts,
                                           slot_id_to_filter_conjuncts, table_info_node_ptr);
    }
};
#include "common/compile_check_end.h"
} // namespace doris::vectorized