snapshot_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 <memory>
#include <string>
 
#include "iceberg/iceberg_export.h"
#include "iceberg/result.h"
#include "iceberg/type_fwd.h"
#include "iceberg/util/error_collector.h"
 
 
namespace iceberg {
 
class ICEBERG_EXPORT SnapshotManager : public ErrorCollector {
 public:
  static Result<std::shared_ptr<SnapshotManager>> Make(std::shared_ptr<Table> table);
 
  static Result<std::shared_ptr<SnapshotManager>> Make(
      std::shared_ptr<Transaction> transaction);
 
  ~SnapshotManager() override;
 
  SnapshotManager& Cherrypick(int64_t snapshot_id);
 
  SnapshotManager& SetCurrentSnapshot(int64_t snapshot_id);
 
  SnapshotManager& RollbackToTime(int64_t timestamp_ms);
 
  SnapshotManager& RollbackTo(int64_t snapshot_id);
 
  SnapshotManager& CreateBranch(const std::string& name);
 
  SnapshotManager& CreateBranch(const std::string& name, int64_t snapshot_id);
 
  SnapshotManager& CreateTag(const std::string& name, int64_t snapshot_id);
 
  SnapshotManager& RemoveBranch(const std::string& name);
 
  SnapshotManager& RemoveTag(const std::string& name);
 
  SnapshotManager& ReplaceTag(const std::string& name, int64_t snapshot_id);
 
  SnapshotManager& ReplaceBranch(const std::string& name, int64_t snapshot_id);
 
  SnapshotManager& ReplaceBranch(const std::string& from, const std::string& to);
 
  SnapshotManager& FastForwardBranch(const std::string& from, const std::string& to);
 
  SnapshotManager& RenameBranch(const std::string& name, const std::string& new_name);
 
  SnapshotManager& SetMinSnapshotsToKeep(const std::string& branch_name,
                                         int32_t min_snapshots_to_keep);
 
  SnapshotManager& SetMaxSnapshotAgeMs(const std::string& branch_name,
                                       int64_t max_snapshot_age_ms);
 
  SnapshotManager& SetMaxRefAgeMs(const std::string& name, int64_t max_ref_age_ms);
 
  Status Commit();
 
 private:
  SnapshotManager(std::shared_ptr<Transaction> transaction, bool is_external_transaction);
 
  Result<std::shared_ptr<UpdateSnapshotReference>> UpdateSnapshotReferencesOperation();
 
  Status CommitIfRefUpdatesExist();
 
  std::shared_ptr<Transaction> transaction_;
  const bool is_external_transaction_;
  std::shared_ptr<UpdateSnapshotReference> update_snap_refs_;
};
 
}  // namespace iceberg