sql_catalog.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 <memory>
#include <string>
#include <string_view>
#include <unordered_map>
#include <unordered_set>
#include <vector>
 
#include "iceberg/catalog.h"
#include "iceberg/catalog/sql/catalog_store.h"
#include "iceberg/catalog/sql/iceberg_sql_catalog_export.h"
#include "iceberg/result.h"
#include "iceberg/table_identifier.h"
#include "iceberg/type_fwd.h"
 
namespace iceberg::sql {
 
constexpr static int32_t kMaxConnections = 10;
 
struct ICEBERG_SQL_CATALOG_EXPORT SqlCatalogConfig {
  std::string name = "sql_catalog";
  std::string uri;
  std::string warehouse_location;
  int32_t max_connections = kMaxConnections;
  std::unordered_map<std::string, std::string> props;
};
 
class ICEBERG_SQL_CATALOG_EXPORT SqlCatalog
    : public Catalog,
      public std::enable_shared_from_this<SqlCatalog> {
 public:
  ~SqlCatalog() override;
 
  SqlCatalog(const SqlCatalog&) = delete;
  SqlCatalog& operator=(const SqlCatalog&) = delete;
  SqlCatalog(SqlCatalog&&) = delete;
  SqlCatalog& operator=(SqlCatalog&&) = delete;
 
  static Result<std::shared_ptr<SqlCatalog>> Make(const SqlCatalogConfig& config,
                                                  std::shared_ptr<FileIO> file_io,
                                                  std::shared_ptr<CatalogStore> store);
 
  std::string_view name() const override;
 
  Status CreateNamespace(
      const Namespace& ns,
      const std::unordered_map<std::string, std::string>& properties) override;
 
  Result<std::vector<Namespace>> ListNamespaces(const Namespace& ns) const override;
 
  Result<std::unordered_map<std::string, std::string>> GetNamespaceProperties(
      const Namespace& ns) const override;
 
  Status DropNamespace(const Namespace& ns) override;
 
  Result<bool> NamespaceExists(const Namespace& ns) const override;
 
  Status UpdateNamespaceProperties(
      const Namespace& ns, const std::unordered_map<std::string, std::string>& updates,
      const std::unordered_set<std::string>& removals) override;
 
  Result<std::vector<TableIdentifier>> ListTables(const Namespace& ns) const override;
 
  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) override;
 
  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) override;
 
  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) override;
 
  Result<bool> TableExists(const TableIdentifier& identifier) const override;
 
  Status DropTable(const TableIdentifier& identifier, bool purge) override;
 
  Status RenameTable(const TableIdentifier& from, const TableIdentifier& to) override;
 
  Result<std::shared_ptr<Table>> LoadTable(const TableIdentifier& identifier) override;
 
  Result<std::shared_ptr<Table>> RegisterTable(
      const TableIdentifier& identifier,
      const std::string& metadata_file_location) override;
 
  static Result<std::shared_ptr<SqlCatalog>> MakeSqliteCatalog(
      const SqlCatalogConfig& config, std::shared_ptr<FileIO> file_io);
 
  static Result<std::shared_ptr<SqlCatalog>> MakePostgreSqlCatalog(
      const SqlCatalogConfig& config, std::shared_ptr<FileIO> file_io);
 
  static Result<std::shared_ptr<SqlCatalog>> MakeMySqlCatalog(
      const SqlCatalogConfig& config, std::shared_ptr<FileIO> file_io);
 
 private:
  SqlCatalog(SqlCatalogConfig config, std::shared_ptr<FileIO> file_io,
             std::shared_ptr<CatalogStore> store,
             std::shared_ptr<MetricsReporter> reporter);
 
  Result<std::string> GetTableMetadataLocation(const TableIdentifier& identifier) const;
 
  Result<std::shared_ptr<Table>> LoadTableFrom(const TableIdentifier& identifier,
                                               const std::string& metadata_location);
 
  SqlCatalogConfig config_;
  std::shared_ptr<FileIO> file_io_;
  std::shared_ptr<CatalogStore> store_;
  std::shared_ptr<MetricsReporter> reporter_;
};
 
}  // namespace iceberg::sql