expire_snapshots.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 <optional>
#include <string>
#include <unordered_map>
#include <unordered_set>
#include <vector>
 
#include "iceberg/iceberg_export.h"
#include "iceberg/result.h"
#include "iceberg/type_fwd.h"
#include "iceberg/update/pending_update.h"
#include "iceberg/util/executor.h"
#include "iceberg/util/timepoint.h"
 
 
namespace iceberg {
 
enum class CleanupLevel : uint8_t {
  kNone,
  kMetadataOnly,
  kAll
};
 
class ICEBERG_EXPORT ExpireSnapshots : public PendingUpdate {
 public:
  static Result<std::shared_ptr<ExpireSnapshots>> Make(
      std::shared_ptr<TransactionContext> ctx);
 
  ~ExpireSnapshots() override;
 
  struct ApplyResult {
    std::vector<std::string> refs_to_remove;
    std::vector<int64_t> snapshot_ids_to_remove;
    std::vector<int32_t> partition_spec_ids_to_remove;
    std::unordered_set<int32_t> schema_ids_to_remove;
    std::shared_ptr<const TableMetadata> metadata_before_expiration;
  };
 
  ExpireSnapshots& ExpireSnapshotId(int64_t snapshot_id);
 
  ExpireSnapshots& ExpireOlderThan(int64_t timestamp_millis);
 
  ExpireSnapshots& RetainLast(int num_snapshots);
 
  ExpireSnapshots& DeleteWith(std::function<void(const std::string&)> delete_func);
 
  ExpireSnapshots& PlanWith(Executor& executor);
 
  ExpireSnapshots& CleanupLevel(enum CleanupLevel level);
 
  ExpireSnapshots& CleanExpiredMetadata(bool clean);
 
  ExpireSnapshots& ExecuteDeleteWith(Executor& executor);
 
  Kind kind() const final { return Kind::kExpireSnapshots; }
  bool IsRetryable() const override { return true; }
 
  Result<ApplyResult> Apply();
 
 private:
  friend class Transaction;
 
  Status Finalize(const TableMetadata& committed) override;
  Status CleanStaged() override {
    apply_result_.reset();
    return {};
  }
  explicit ExpireSnapshots(std::shared_ptr<TransactionContext> ctx);
 
  using SnapshotToRef = std::unordered_map<std::string, std::shared_ptr<SnapshotRef>>;
 
  Result<SnapshotToRef> ComputeRetainedRefs(const SnapshotToRef& refs) const;
 
  Result<std::unordered_set<int64_t>> ComputeBranchSnapshotsToRetain(
      int64_t snapshot_id, TimePointMs expire_snapshot_older_than,
      int32_t min_snapshots_to_keep) const;
 
  Result<std::unordered_set<int64_t>> ComputeAllBranchSnapshotIdsToRetain(
      const SnapshotToRef& refs) const;
 
  Result<std::unordered_set<int64_t>> UnreferencedSnapshotIdsToRetain(
      const SnapshotToRef& refs) const;
 
  const TimePointMs current_time_ms_;
  const int64_t default_max_ref_age_ms_;
  int32_t default_min_num_snapshots_;
  TimePointMs default_expire_older_than_;
  std::function<void(const std::string&)> delete_func_;
  std::vector<int64_t> snapshot_ids_to_expire_;
  enum CleanupLevel cleanup_level_ { CleanupLevel::kAll };
  OptionalExecutor plan_executor_;
  bool clean_expired_metadata_{false};
  bool specified_snapshot_id_{false};
  OptionalExecutor delete_executor_;
 
  std::optional<ApplyResult> apply_result_;
};
 
}  // namespace iceberg