snapshot_util.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 <functional>
#include <memory>
#include <optional>
#include <string>
#include <vector>
 
#include "iceberg/iceberg_export.h"
#include "iceberg/result.h"
#include "iceberg/type_fwd.h"
#include "iceberg/util/timepoint.h"
 
namespace iceberg {
 
class ICEBERG_EXPORT SnapshotUtil {
 public:
  static Result<std::vector<std::shared_ptr<Snapshot>>> AncestorsOf(const Table& table,
                                                                    int64_t snapshot_id);
 
  static Result<std::vector<std::shared_ptr<Snapshot>>> AncestorsOf(
      const TableMetadata& metadata, int64_t snapshot_id);
 
  static Result<std::vector<std::shared_ptr<Snapshot>>> AncestorsOf(
      int64_t snapshot_id,
      const std::function<Result<std::shared_ptr<Snapshot>>(int64_t)>& lookup);
 
  static Result<bool> IsAncestorOf(const Table& table, int64_t ancestor_snapshot_id);
 
  static Result<bool> IsAncestorOf(const TableMetadata& metadata,
                                   int64_t ancestor_snapshot_id);
 
  static Result<bool> IsAncestorOf(const Table& table, int64_t snapshot_id,
                                   int64_t ancestor_snapshot_id);
 
  static Result<bool> IsAncestorOf(const TableMetadata& metadata, int64_t snapshot_id,
                                   int64_t ancestor_snapshot_id);
 
  static Result<bool> IsAncestorOf(
      int64_t snapshot_id, int64_t ancestor_snapshot_id,
      const std::function<Result<std::shared_ptr<Snapshot>>(int64_t)>& lookup);
 
  static Result<bool> IsParentAncestorOf(const Table& table, int64_t snapshot_id,
                                         int64_t ancestor_parent_snapshot_id);
 
  static Result<bool> IsParentAncestorOf(const TableMetadata& metadata,
                                         int64_t snapshot_id,
                                         int64_t ancestor_parent_snapshot_id);
 
  static Result<bool> IsParentAncestorOf(
      int64_t snapshot_id, int64_t ancestor_parent_snapshot_id,
      const std::function<Result<std::shared_ptr<Snapshot>>(int64_t)>& lookup);
 
  static Result<std::vector<std::shared_ptr<Snapshot>>> CurrentAncestors(
      const Table& table);
 
  static Result<std::vector<std::shared_ptr<Snapshot>>> CurrentAncestors(
      const TableMetadata& metadata);
 
  static Result<std::vector<int64_t>> CurrentAncestorIds(const Table& table);
 
  static Result<std::optional<std::shared_ptr<Snapshot>>> OldestAncestor(
      const Table& table);
 
  static Result<std::optional<std::shared_ptr<Snapshot>>> OldestAncestorOf(
      const Table& table, int64_t snapshot_id);
 
  static Result<std::optional<std::shared_ptr<Snapshot>>> OldestAncestorOf(
      const TableMetadata& metadata, int64_t snapshot_id);
 
  static Result<std::optional<std::shared_ptr<Snapshot>>> OldestAncestorAfter(
      const Table& table, TimePointMs timestamp_ms);
 
  static Result<std::vector<int64_t>> SnapshotIdsBetween(const Table& table,
                                                         int64_t from_snapshot_id,
                                                         int64_t to_snapshot_id);
 
  static Result<std::vector<int64_t>> AncestorIdsBetween(
      const Table& table, int64_t latest_snapshot_id,
      const std::optional<int64_t>& oldest_snapshot_id);
 
  static Result<std::vector<std::shared_ptr<Snapshot>>> AncestorsBetween(
      const Table& table, int64_t latest_snapshot_id,
      std::optional<int64_t> oldest_snapshot_id);
 
  static Result<std::vector<std::shared_ptr<Snapshot>>> AncestorsBetween(
      const TableMetadata& metadata, int64_t latest_snapshot_id,
      std::optional<int64_t> oldest_snapshot_id);
 
  static Result<std::shared_ptr<Snapshot>> SnapshotAfter(const Table& table,
                                                         int64_t snapshot_id);
 
  static Result<int64_t> SnapshotIdAsOfTime(const Table& table, TimePointMs timestamp_ms);
 
  static Result<int64_t> SnapshotIdAsOfTime(const TableMetadata& metadata,
                                            TimePointMs timestamp_ms);
 
  static std::optional<int64_t> OptionalSnapshotIdAsOfTime(const Table& table,
                                                           TimePointMs timestamp_ms);
 
  static Result<std::shared_ptr<Schema>> SchemaFor(const Table& table,
                                                   int64_t snapshot_id);
 
  static Result<std::shared_ptr<Schema>> SchemaFor(const Table& table,
                                                   TimePointMs timestamp_ms);
 
  static Result<std::shared_ptr<Schema>> SchemaFor(const Table& table,
                                                   const std::string& ref);
 
  static Result<std::shared_ptr<Schema>> SchemaFor(const TableMetadata& metadata,
                                                   const std::string& ref);
 
  static Result<std::shared_ptr<Snapshot>> LatestSnapshot(const Table& table,
                                                          const std::string& branch);
 
  static Result<std::shared_ptr<Snapshot>> LatestSnapshot(const TableMetadata& metadata,
                                                          const std::string& branch);
 
  static Result<std::shared_ptr<Snapshot>> OptionalLatestSnapshot(
      const TableMetadata& metadata, const std::string& branch);
 
  static int64_t GenerateSnapshotId();
 
  static int64_t GenerateSnapshotId(const TableMetadata& metadata);
 
 private:
  static Result<std::vector<std::shared_ptr<Snapshot>>> AncestorsOf(
      const TableMetadata& metadata, const std::shared_ptr<Snapshot>& snapshot);
 
  static Result<std::vector<std::shared_ptr<Snapshot>>> AncestorsOf(
      const std::shared_ptr<Snapshot>& snapshot,
      const std::function<Result<std::shared_ptr<Snapshot>>(int64_t)>& lookup);
 
  static Result<std::vector<int64_t>> ToIds(
      const std::vector<std::shared_ptr<Snapshot>>& snapshots);
};
 
}  // namespace iceberg