iceberg_catalog_s3tables/
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 s3tables catalog implementation.
19//!
20//! To build an s3tables catalog with configurations
21//!
22//! # Example
23//!
24//! ```rust, no_run
25//! use std::collections::HashMap;
26//!
27//! use iceberg::CatalogBuilder;
28//! use iceberg_catalog_s3tables::{
29//!     S3TABLES_CATALOG_PROP_ENDPOINT_URL, S3TABLES_CATALOG_PROP_TABLE_BUCKET_ARN,
30//!     S3TablesCatalogBuilder,
31//! };
32//!
33//! #[tokio::main]
34//! async fn main() {
35//!     let catalog = S3TablesCatalogBuilder::default()
36//!         .with_endpoint_url("http://localhost:4566")
37//!         .load(
38//!             "s3tables",
39//!             HashMap::from([(
40//!                 S3TABLES_CATALOG_PROP_TABLE_BUCKET_ARN.to_string(),
41//!                 "arn:aws:s3tables:us-east-1:123456789012:bucket/my-bucket".to_string(),
42//!             )]),
43//!         )
44//!         .await
45//!         .unwrap();
46//! }
47//! ```
48
49#![deny(missing_docs)]
50
51mod catalog;
52mod utils;
53
54pub use catalog::*;
iceberg_catalog_s3tables/lib.rs

iceberg_catalog_s3tables/
lib.rs
