iceberg_catalog_hms/lib.rs
1// Licensed to the Apache Software Foundation (ASF) under one
2// or more contributor license agreements. See the NOTICE file
3// distributed with this work for additional information
4// regarding copyright ownership. The ASF licenses this file
5// to you under the Apache License, Version 2.0 (the
6// "License"); you may not use this file except in compliance
7// with the License. You may obtain a copy of the License at
8//
9// http://www.apache.org/licenses/LICENSE-2.0
10//
11// Unless required by applicable law or agreed to in writing,
12// software distributed under the License is distributed on an
13// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14// KIND, either express or implied. See the License for the
15// specific language governing permissions and limitations
16// under the License.
17
18//! Iceberg Hive Metastore Catalog implementation.
19//!
20//! To build a hive metastore with configurations
21//! # Example
22//!
23//! ```rust, no_run
24//! use std::collections::HashMap;
25//!
26//! use iceberg::CatalogBuilder;
27//! use iceberg_catalog_hms::{
28//! HMS_CATALOG_PROP_URI, HMS_CATALOG_PROP_WAREHOUSE, HmsCatalogBuilder,
29//! };
30//!
31//! #[tokio::main]
32//! async fn main() {
33//! let catalog = HmsCatalogBuilder::default()
34//! .load(
35//! "hms",
36//! HashMap::from([
37//! (HMS_CATALOG_PROP_URI.to_string(), "127.0.0.1:1".to_string()),
38//! (
39//! HMS_CATALOG_PROP_WAREHOUSE.to_string(),
40//! "s3://warehouse".to_string(),
41//! ),
42//! ]),
43//! )
44//! .await
45//! .unwrap();
46//! }
47//! ```
48
49#![deny(missing_docs)]
50
51mod catalog;
52pub use catalog::*;
53
54mod error;
55mod schema;
56mod utils;