manifest_filter_manager.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 <functional>
#include <memory>
#include <string>
#include <unordered_map>
#include <unordered_set>
#include <vector>
 
#include "iceberg/iceberg_export.h"
#include "iceberg/manifest/manifest_list.h"
#include "iceberg/manifest/manifest_writer.h"
#include "iceberg/result.h"
#include "iceberg/snapshot.h"
#include "iceberg/type_fwd.h"
#include "iceberg/util/data_file_set.h"
#include "iceberg/util/partition_value_util.h"
 
namespace iceberg {
 
class ICEBERG_EXPORT ManifestFilterManager {
 public:
  using PartitionSpecsById = std::unordered_map<int32_t, std::shared_ptr<PartitionSpec>>;
 
  static Result<std::unique_ptr<ManifestFilterManager>> Make(
      ManifestContent content, std::shared_ptr<FileIO> file_io,
      std::function<Status(const std::string&)> delete_file = {});
  ~ManifestFilterManager();
 
  ManifestFilterManager(const ManifestFilterManager&) = delete;
  ManifestFilterManager& operator=(const ManifestFilterManager&) = delete;
 
  Status DeleteByRowFilter(std::shared_ptr<Expression> expr);
 
  void CaseSensitive(bool case_sensitive);
 
  Status DeleteFile(std::string_view path);
 
  Status DeleteFile(std::shared_ptr<DataFile> file);
 
  const DataFileSet& FilesToBeDeleted() const;
 
  const std::vector<std::shared_ptr<DataFile>>& DeletedFiles() const;
 
  int32_t DuplicateDeletesCount() const { return duplicate_deletes_count_; }
 
  Result<SnapshotSummaryBuilder> BuildSummary(
      const std::vector<ManifestFile>& manifests,
      const PartitionSpecsById& specs_by_id) const;
 
  Status DropPartition(int32_t spec_id, PartitionValues partition);
 
  void FailMissingDeletePaths();
 
  void FailAnyDelete();
 
  int32_t ReplacedManifestsCount() const { return replaced_manifests_count_; }
 
  bool ContainsDeletes() const;
 
  Status DropDeleteFilesOlderThan(int64_t sequence_number);
 
  void RemoveDanglingDeletesFor(const DataFileSet& deleted_files);
 
  Result<std::vector<ManifestFile>> FilterManifests(
      const TableMetadata& metadata, const std::shared_ptr<Snapshot>& base_snapshot,
      const ManifestWriterFactory& writer_factory);
 
  Result<std::vector<ManifestFile>> FilterManifests(
      const std::shared_ptr<Schema>& schema, const TableMetadata& metadata,
      const std::shared_ptr<Snapshot>& base_snapshot,
      const ManifestWriterFactory& writer_factory);
 
  Result<std::vector<ManifestFile>> FilterManifests(
      const std::shared_ptr<Schema>& schema, const PartitionSpecsById& specs_by_id,
      const std::vector<const ManifestFile*>& manifests,
      const ManifestWriterFactory& writer_factory);
 
  Status CleanUncommitted(const std::unordered_set<std::string>& committed);
 
 private:
  ManifestFilterManager(ManifestContent content, std::shared_ptr<FileIO> file_io,
                        std::function<Status(const std::string&)> delete_file);
 
  Result<bool> CanContainExpressionDeletes(const ManifestFile& manifest,
                                           const std::shared_ptr<Schema>& schema,
                                           const PartitionSpecsById& specs_by_id);
 
  Result<bool> CanContainDroppedPartitions(const ManifestFile& manifest) const;
 
  Result<bool> CanContainDroppedFiles(const ManifestFile& manifest) const;
 
  Result<bool> CanContainDeletedFiles(const ManifestFile& manifest,
                                      const std::shared_ptr<Schema>& schema,
                                      const PartitionSpecsById& specs_by_id,
                                      bool trust_manifest_references);
 
  bool CanTrustManifestReferences(
      const std::vector<const ManifestFile*>& manifests) const;
 
  struct FilteredManifestDeletes {
    std::vector<std::shared_ptr<DataFile>> files;
    int32_t duplicate_deletes_count = 0;
  };
 
  Result<ManifestFile> FilterManifest(const std::shared_ptr<Schema>& schema,
                                      const PartitionSpecsById& specs_by_id,
                                      const ManifestFile& manifest,
                                      bool trust_manifest_references,
                                      const ManifestWriterFactory& writer_factory);
 
  Result<bool> ManifestHasDeletedFiles(const std::vector<ManifestEntry>& entries,
                                       const std::shared_ptr<Schema>& schema,
                                       const PartitionSpecsById& specs_by_id,
                                       int32_t manifest_spec_id);
 
  Result<ManifestFile> FilterManifestWithDeletedFiles(
      const std::vector<ManifestEntry>& entries, int32_t manifest_spec_id,
      const std::shared_ptr<Schema>& schema, const PartitionSpecsById& specs_by_id,
      const ManifestWriterFactory& writer_factory);
 
  Status ValidateRequiredDeletes() const;
 
  Status InvalidateFilteredCache();
  void ResetDeletedFiles();
 
  Result<ManifestEvaluator*> GetManifestEvaluator(const std::shared_ptr<Schema>& schema,
                                                  const PartitionSpecsById& specs_by_id,
                                                  int32_t spec_id);
 
  Result<ResidualEvaluator*> GetResidualEvaluator(const std::shared_ptr<Schema>& schema,
                                                  const PartitionSpecsById& specs_by_id,
                                                  int32_t spec_id);
 
  Result<bool> ShouldDelete(const ManifestEntry& entry,
                            const std::shared_ptr<Schema>& schema,
                            const PartitionSpecsById& specs_by_id,
                            int32_t manifest_spec_id);
 
  const ManifestContent manifest_content_;
  std::shared_ptr<FileIO> file_io_;
  std::function<Status(const std::string&)> delete_file_;
 
  std::shared_ptr<Expression> delete_expr_;
  std::unordered_set<std::string> delete_paths_;
  // Delete files explicitly registered for deletion by object identity.
  DeleteFileSet delete_files_to_delete_;
  // Data files explicitly registered for deletion by object identity.
  DataFileSet data_files_to_delete_;
  // Data files to remove: explicit object deletes plus files found while filtering.
  DataFileSet data_files_;
  // Delete files to remove: explicit object deletes plus files found while filtering.
  DeleteFileSet delete_files_;
  std::unordered_map<ManifestFile, FilteredManifestDeletes>
      filtered_manifest_to_deleted_files_;
  // Ordered files deleted by the latest filter pass, used for summaries.
  std::vector<std::shared_ptr<DataFile>> deleted_files_;
  // Data-file identity set for latest-pass dedup and required-delete validation.
  DataFileSet deleted_data_file_set_;
  // Delete-file identity set for latest-pass dedup and required-delete validation.
  DeleteFileSet deleted_delete_file_set_;
  PartitionSet drop_partitions_;
  bool fail_missing_delete_paths_{false};
  bool fail_any_delete_{false};
  bool case_sensitive_{true};
  int32_t duplicate_deletes_count_{0};
  int32_t replaced_manifests_count_{0};
 
  // minimum data sequence number; delete entries older than this are dropped
  int64_t min_sequence_number_{0};
  // paths of data files that were removed; DVs referencing these are dangling
  std::unordered_set<std::string> removed_data_file_paths_;
 
  std::unordered_map<ManifestFile, ManifestFile> filtered_manifests_;
 
  std::unordered_map<int32_t, std::unique_ptr<ManifestEvaluator>>
      manifest_evaluator_cache_;
  std::unordered_map<int32_t, std::unique_ptr<ResidualEvaluator>>
      residual_evaluator_cache_;
};
 
}  // namespace iceberg