catalog.h

/*
 * 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 <string_view>
#include <unordered_map>
#include <unordered_set>
#include <vector>
 
#include "iceberg/result.h"
#include "iceberg/table_identifier.h"
#include "iceberg/type_fwd.h"
 
namespace iceberg {
 
class ICEBERG_EXPORT Catalog {
 public:
  virtual ~Catalog() = default;
 
  virtual std::string_view name() const = 0;
 
  virtual Status CreateNamespace(
      const Namespace& ns,
      const std::unordered_map<std::string, std::string>& properties) = 0;
 
  virtual Result<std::vector<Namespace>> ListNamespaces(const Namespace& ns) const = 0;
 
  virtual Result<std::unordered_map<std::string, std::string>> GetNamespaceProperties(
      const Namespace& ns) const = 0;
 
  virtual Status DropNamespace(const Namespace& ns) = 0;
 
  virtual Result<bool> NamespaceExists(const Namespace& ns) const = 0;
 
  virtual Status UpdateNamespaceProperties(
      const Namespace& ns, const std::unordered_map<std::string, std::string>& updates,
      const std::unordered_set<std::string>& removals) = 0;
 
  virtual Result<std::vector<TableIdentifier>> ListTables(const Namespace& ns) const = 0;
 
  virtual Result<std::shared_ptr<Table>> CreateTable(
      const TableIdentifier& identifier, const std::shared_ptr<Schema>& schema,
      const std::shared_ptr<PartitionSpec>& spec, const std::shared_ptr<SortOrder>& order,
      const std::string& location,
      const std::unordered_map<std::string, std::string>& properties) = 0;
 
  virtual Result<std::shared_ptr<Table>> UpdateTable(
      const TableIdentifier& identifier,
      const std::vector<std::unique_ptr<TableRequirement>>& requirements,
      const std::vector<std::unique_ptr<TableUpdate>>& updates) = 0;
 
  virtual Result<std::shared_ptr<Transaction>> StageCreateTable(
      const TableIdentifier& identifier, const std::shared_ptr<Schema>& schema,
      const std::shared_ptr<PartitionSpec>& spec, const std::shared_ptr<SortOrder>& order,
      const std::string& location,
      const std::unordered_map<std::string, std::string>& properties) = 0;
 
  virtual Result<bool> TableExists(const TableIdentifier& identifier) const = 0;
 
  virtual Status DropTable(const TableIdentifier& identifier, bool purge) = 0;
 
  virtual Status RenameTable(const TableIdentifier& from, const TableIdentifier& to) = 0;
 
  virtual Result<std::shared_ptr<Table>> LoadTable(const TableIdentifier& identifier) = 0;
 
  virtual Result<std::shared_ptr<Table>> RegisterTable(
      const TableIdentifier& identifier, const std::string& metadata_file_location) = 0;
};
 
}  // namespace iceberg