catalog_store.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 <functional>
#include <memory>
#include <optional>
#include <string>
#include <string_view>
#include <unordered_map>
#include <vector>
 
#include "iceberg/catalog/sql/iceberg_sql_catalog_export.h"
#include "iceberg/result.h"
 
namespace iceberg::sql {
 
struct ICEBERG_SQL_CATALOG_EXPORT NamespaceProperty {
  std::string key;
  std::optional<std::string> value;
};
 
struct ICEBERG_SQL_CATALOG_EXPORT CatalogStoreOptions {
  std::string catalog_name;
  std::string uri;
  int32_t max_connections = 1;
  std::unordered_map<std::string, std::string> properties;
};
 
class ICEBERG_SQL_CATALOG_EXPORT CatalogStore {
 public:
  virtual ~CatalogStore() = default;
 
  virtual Status Initialize() = 0;
 
  virtual Result<std::vector<std::string>> ListNamespaceNames() = 0;
 
  virtual Result<std::vector<NamespaceProperty>> GetNamespaceProperties(
      std::string_view ns) = 0;
 
  virtual Status InsertNamespaceProperty(std::string_view ns, std::string_view key,
                                         std::optional<std::string_view> value) = 0;
 
  virtual Status DeleteNamespaceProperty(std::string_view ns, std::string_view key) = 0;
 
  virtual Result<int64_t> DeleteNamespace(std::string_view ns) = 0;
 
  virtual Result<std::vector<std::string>> ListTableNames(std::string_view ns) = 0;
 
  virtual Result<bool> TableExists(std::string_view ns, std::string_view name) = 0;
 
  virtual Result<std::optional<std::string>> GetTableMetadataLocation(
      std::string_view ns, std::string_view name) = 0;
 
  virtual Status InsertTable(std::string_view ns, std::string_view name,
                             std::string_view metadata_location) = 0;
 
  virtual Result<int64_t> UpdateTableMetadataLocation(
      std::string_view ns, std::string_view name, std::string_view new_location,
      std::string_view new_previous_location,
      std::string_view expected_current_location) = 0;
 
  virtual Result<int64_t> DeleteTable(std::string_view ns, std::string_view name) = 0;
 
  virtual Result<int64_t> RenameTable(std::string_view from_ns,
                                      std::string_view from_name, std::string_view to_ns,
                                      std::string_view to_name) = 0;
 
  virtual Status RunInTransaction(const std::function<Status()>& body) = 0;
};
 
ICEBERG_SQL_CATALOG_EXPORT Result<std::shared_ptr<CatalogStore>> MakeSqliteCatalogStore(
    const CatalogStoreOptions& options);
 
ICEBERG_SQL_CATALOG_EXPORT Result<std::shared_ptr<CatalogStore>>
MakePostgreSqlCatalogStore(const CatalogStoreOptions& options);
 
ICEBERG_SQL_CATALOG_EXPORT Result<std::shared_ptr<CatalogStore>> MakeMySqlCatalogStore(
    const CatalogStoreOptions& options);
 
}  // namespace iceberg::sql