hive_utils.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 <string>
#include <string_view>
#include <unordered_map>
#include <vector>
 
#include "iceberg/catalog/hive/hive_schema.h"
#include "iceberg/catalog/hive/iceberg_hive_export.h"
#include "iceberg/result.h"
#include "iceberg/table_identifier.h"
 
 
namespace iceberg::hive {
 
inline constexpr std::string_view kMetadataLocationKey = "metadata_location";
inline constexpr std::string_view kTableTypeKey = "table_type";
inline constexpr std::string_view kTableTypeIceberg = "ICEBERG";
inline constexpr std::string_view kExternalKey = "EXTERNAL";
inline constexpr std::string_view kExternalTrue = "TRUE";
 
inline constexpr std::string_view kCommentProperty = "comment";
inline constexpr std::string_view kLocationProperty = "location";
 
inline constexpr std::string_view kHmsTableOwnerProperty = "hive.metastore.table.owner";
 
inline constexpr std::string_view kHmsDbOwnerProperty = "hive.metastore.database.owner";
inline constexpr std::string_view kHmsDbOwnerTypeProperty =
    "hive.metastore.database.owner-type";
 
inline constexpr std::string_view kLazySimpleSerDe =
    "org.apache.hadoop.hive.serde2.lazy.LazySimpleSerDe";
inline constexpr std::string_view kFileInputFormat =
    "org.apache.hadoop.mapred.FileInputFormat";
inline constexpr std::string_view kFileOutputFormat =
    "org.apache.hadoop.mapred.FileOutputFormat";
 
struct ICEBERG_HIVE_EXPORT HiveDatabase {
  std::string name;
  std::string description;
  std::string location_uri;
  std::unordered_map<std::string, std::string> parameters;
  std::string owner_name;
  std::string owner_type;  // "USER", "GROUP" or "ROLE"; empty means HMS-default
};
 
struct ICEBERG_HIVE_EXPORT HiveTable {
  std::string db_name;
  std::string table_name;
  std::string owner;
  std::string table_type;  // "EXTERNAL_TABLE" for Iceberg tables
  std::string location;
  std::vector<HiveColumn> columns;
  std::unordered_map<std::string, std::string> parameters;
  std::string serde;
  std::string input_format;
  std::string output_format;
};
 
struct ICEBERG_HIVE_EXPORT HiveNamespace {
  Namespace ns;
  std::unordered_map<std::string, std::string> properties;
};
 
ICEBERG_HIVE_EXPORT Result<HiveDatabase> ConvertToHiveDatabase(
    const Namespace& ns, const std::unordered_map<std::string, std::string>& properties);
 
ICEBERG_HIVE_EXPORT HiveNamespace ConvertFromHiveDatabase(const HiveDatabase& database);
 
ICEBERG_HIVE_EXPORT Result<HiveTable> ConvertToHiveTable(
    const TableIdentifier& identifier, const std::vector<HiveColumn>& columns,
    std::string_view metadata_location, std::string_view location,
    const std::unordered_map<std::string, std::string>& table_properties);
 
ICEBERG_HIVE_EXPORT Result<std::string> GetMetadataLocation(
    const std::unordered_map<std::string, std::string>& table_parameters);
 
ICEBERG_HIVE_EXPORT Status ValidateIcebergTable(
    const TableIdentifier& identifier,
    const std::unordered_map<std::string, std::string>& table_parameters);
 
ICEBERG_HIVE_EXPORT std::string GetDefaultTableLocation(std::string_view warehouse,
                                                        const Namespace& ns,
                                                        std::string_view table_name);
 
ICEBERG_HIVE_EXPORT Status ValidateNamespace(const Namespace& ns);
 
ICEBERG_HIVE_EXPORT Status
ValidateOwnerSettings(const std::unordered_map<std::string, std::string>& properties);
 
}  // namespace iceberg::hive