manifest_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 <cstdint>
#include <memory>
#include <optional>
#include <string>
#include <unordered_map>
#include <vector>
 
#include "iceberg/iceberg_export.h"
#include "iceberg/manifest/manifest_entry.h"
#include "iceberg/metrics/counter.h"
#include "iceberg/result.h"
#include "iceberg/type_fwd.h"
#include "iceberg/util/stream.h"
 
namespace iceberg {
 
using ManifestEntryStream = Stream<ManifestEntry>;
 
using ManifestEntryStreamPtr = std::unique_ptr<ManifestEntryStream>;
 
class ICEBERG_EXPORT ManifestReader {
 public:
  virtual ~ManifestReader() = default;
 
  Result<std::vector<ManifestEntry>> Entries();
 
  Result<std::vector<ManifestEntry>> LiveEntries();
 
  virtual Result<ManifestEntryStreamPtr> EntriesStream() = 0;
 
  virtual Result<ManifestEntryStreamPtr> LiveEntriesStream() = 0;
 
  virtual ManifestReader& Select(const std::vector<std::string>& columns) = 0;
 
  virtual ManifestReader& FilterPartitions(std::shared_ptr<Expression> expr) = 0;
 
  virtual ManifestReader& FilterPartitions(
      std::shared_ptr<class PartitionSet> partition_set) = 0;
 
  virtual ManifestReader& FilterRows(std::shared_ptr<Expression> expr) = 0;
 
  virtual ManifestReader& CaseSensitive(bool case_sensitive) = 0;
 
  virtual ManifestReader& TryDropStats() = 0;
 
  virtual ManifestReader& SkipCounter(std::shared_ptr<Counter> counter) = 0;
 
  static bool ShouldDropStats(const std::vector<std::string>& columns);
 
  static Result<std::unique_ptr<ManifestReader>> Make(const ManifestFile& manifest,
                                                      std::shared_ptr<FileIO> file_io,
                                                      std::shared_ptr<Schema> schema,
                                                      std::shared_ptr<PartitionSpec> spec,
                                                      bool is_committed = true);
 
  static Result<std::unique_ptr<ManifestReader>> Make(
      const ManifestFile& manifest, std::shared_ptr<FileIO> file_io,
      std::shared_ptr<Schema> schema,
      const std::unordered_map<int32_t, std::shared_ptr<PartitionSpec>>& specs_by_id,
      bool is_committed = true);
 
  static Result<std::unique_ptr<ManifestReader>> Make(
      std::string_view manifest_location, std::optional<int64_t> manifest_length,
      std::shared_ptr<FileIO> file_io, std::shared_ptr<Schema> schema,
      std::shared_ptr<PartitionSpec> spec,
      std::unique_ptr<InheritableMetadata> inheritable_metadata,
      std::optional<int64_t> first_row_id = std::nullopt, bool is_committed = true);
 
  static std::vector<std::string> WithStatsColumns(
      const std::vector<std::string>& columns);
};
 
class ICEBERG_EXPORT ManifestListReader {
 public:
  virtual ~ManifestListReader() = default;
 
  virtual Result<std::vector<ManifestFile>> Files() const = 0;
 
  virtual Result<std::unordered_map<std::string, std::string>> Metadata() const = 0;
 
  static Result<std::unique_ptr<ManifestListReader>> Make(
      std::string_view manifest_list_location, std::shared_ptr<FileIO> file_io);
};
 
}  // namespace iceberg