update_snapshot_reference.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 "iceberg/iceberg_export.h"
#include "iceberg/result.h"
#include "iceberg/type_fwd.h"
#include "iceberg/update/pending_update.h"
 
 
namespace iceberg {
 
class ICEBERG_EXPORT UpdateSnapshotReference : public PendingUpdate {
 public:
  static Result<std::shared_ptr<UpdateSnapshotReference>> Make(
      std::shared_ptr<TransactionContext> ctx);
 
  ~UpdateSnapshotReference() override;
 
  UpdateSnapshotReference& CreateBranch(const std::string& name, int64_t snapshot_id);
 
  UpdateSnapshotReference& CreateTag(const std::string& name, int64_t snapshot_id);
 
  UpdateSnapshotReference& RemoveBranch(const std::string& name);
 
  UpdateSnapshotReference& RemoveTag(const std::string& name);
 
  UpdateSnapshotReference& RenameBranch(const std::string& name,
                                        const std::string& new_name);
 
  UpdateSnapshotReference& ReplaceBranch(const std::string& name, int64_t snapshot_id);
 
  UpdateSnapshotReference& ReplaceBranch(const std::string& from, const std::string& to);
 
  UpdateSnapshotReference& FastForward(const std::string& from, const std::string& to);
 
  UpdateSnapshotReference& ReplaceTag(const std::string& name, int64_t snapshot_id);
 
  UpdateSnapshotReference& SetMinSnapshotsToKeep(const std::string& name,
                                                 int32_t min_snapshots_to_keep);
 
  UpdateSnapshotReference& SetMaxSnapshotAgeMs(const std::string& name,
                                               int64_t max_snapshot_age_ms);
 
  UpdateSnapshotReference& SetMaxRefAgeMs(const std::string& name,
                                          int64_t max_ref_age_ms);
 
  Kind kind() const final { return Kind::kUpdateSnapshotReference; }
 
  bool IsRetryable() const override { return false; }
 
  struct ApplyResult {
    std::vector<std::pair<std::string, std::shared_ptr<SnapshotRef>>> to_set;
    std::vector<std::string> to_remove;
  };
 
  Result<ApplyResult> Apply();
 
 private:
  explicit UpdateSnapshotReference(std::shared_ptr<TransactionContext> ctx);
 
  UpdateSnapshotReference& ReplaceBranchInternal(const std::string& from,
                                                 const std::string& to,
                                                 bool fast_forward);
 
  std::unordered_map<std::string, std::shared_ptr<SnapshotRef>> updated_refs_;
};
 
}  // namespace iceberg