rewrite_files.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 <optional>
#include <string>
#include <vector>
 
#include "iceberg/iceberg_export.h"
#include "iceberg/result.h"
#include "iceberg/type_fwd.h"
#include "iceberg/update/merging_snapshot_update.h"
#include "iceberg/util/data_file_set.h"
 
namespace iceberg {
 
class ICEBERG_EXPORT RewriteFiles : public MergingSnapshotUpdate {
 public:
  static Result<std::unique_ptr<RewriteFiles>> Make(
      std::string table_name, std::shared_ptr<TransactionContext> ctx);
 
  ~RewriteFiles() override = default;
 
  RewriteFiles& DeleteDataFile(const std::shared_ptr<DataFile>& data_file);
 
  RewriteFiles& DeleteDeleteFile(const std::shared_ptr<DataFile>& delete_file);
 
  RewriteFiles& AddDataFile(const std::shared_ptr<DataFile>& file);
 
  RewriteFiles& AddDeleteFile(const std::shared_ptr<DataFile>& delete_file);
 
  RewriteFiles& AddDeleteFile(const std::shared_ptr<DataFile>& delete_file,
                              int64_t data_sequence_number);
 
  RewriteFiles& SetDataSequenceNumber(int64_t sequence_number);
 
  RewriteFiles& RewriteDataFiles(
      const std::vector<std::shared_ptr<DataFile>>& files_to_delete,
      const std::vector<std::shared_ptr<DataFile>>& files_to_add,
      int64_t sequence_number);
 
  RewriteFiles& Rewrite(
      const std::vector<std::shared_ptr<DataFile>>& data_files_to_replace,
      const std::vector<std::shared_ptr<DataFile>>& delete_files_to_replace,
      const std::vector<std::shared_ptr<DataFile>>& data_files_to_add,
      const std::vector<std::shared_ptr<DataFile>>& delete_files_to_add);
 
  RewriteFiles& ValidateFromSnapshot(int64_t snapshot_id);
 
  std::string operation() override;
 
 protected:
  Status Validate(const TableMetadata& current_metadata,
                  const std::shared_ptr<Snapshot>& snapshot) override;
 
  explicit RewriteFiles(std::string table_name, std::shared_ptr<TransactionContext> ctx);
 
 private:
  void ValidateReplacedAndAddedFiles();
 
  DataFileSet replaced_data_files_;
 
  std::optional<int64_t> starting_snapshot_id_;
};
 
}  // namespace iceberg