file_scan_task_reader.h

Go to the documentation of this file.

/*
 * 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 <string>
#include <unordered_map>
#include <vector>
 
#include "iceberg/arrow_c_data.h"
#include "iceberg/iceberg_data_export.h"
#include "iceberg/result.h"
#include "iceberg/type_fwd.h"
 
namespace iceberg {
 
class ICEBERG_DATA_EXPORT FileScanTaskReader {
 public:
  struct Options {
    std::shared_ptr<FileIO> io;
    std::shared_ptr<Schema> table_schema;
    std::vector<std::shared_ptr<Schema>> schemas;
    std::shared_ptr<Schema> projected_schema;
    bool case_sensitive = true;
    std::shared_ptr<NameMapping> name_mapping;
    std::unordered_map<std::string, std::string> properties;
    bool apply_residuals{false};
  };
 
  static Result<std::unique_ptr<FileScanTaskReader>> Make(Options options);
 
  ~FileScanTaskReader();
 
  Result<ArrowArrayStream> Open(const FileScanTask& task);
 
  FileScanTaskReader(const FileScanTaskReader&) = delete;
  FileScanTaskReader& operator=(const FileScanTaskReader&) = delete;
 
 private:
  class Impl;
  explicit FileScanTaskReader(std::unique_ptr<Impl> impl);
  std::unique_ptr<Impl> impl_;
};
 
}  // namespace iceberg