Skip to content

Experiment implementation for catalog builder #1231

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 7 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

18 changes: 18 additions & 0 deletions crates/catalog/loader/Cargo.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
[package]
name = "iceberg-catalog-loader"
edition = { workspace = true }
homepage = { workspace = true }
rust-version = { workspace = true }
version = { workspace = true }

categories = ["database"]
description = "Apache Iceberg Catalog Loader API"
keywords = ["iceberg", "catalog"]
license = { workspace = true }
repository = { workspace = true }

[dependencies]
iceberg = { workspace = true }
iceberg-catalog-rest = {workspace = true}
tokio = { workspace = true }
async-trait = {workspace = true}
44 changes: 44 additions & 0 deletions crates/catalog/loader/src/lib.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
use async_trait::async_trait;
use std::collections::HashMap;
use std::future::Future;
use std::sync::Arc;

use iceberg::{Catalog, CatalogBuilder, Error, ErrorKind, Result};
use iceberg_catalog_rest::RestCatalogBuilder;

#[async_trait]
pub trait BoxedCatalogBuilder {
async fn load(self: Box<Self>, name: String, props: HashMap<String, String>) -> Result<Arc<dyn Catalog>>;
}

#[async_trait]
impl<T: CatalogBuilder + 'static> BoxedCatalogBuilder for T {
async fn load(self: Box<Self>, name: String, props: HashMap<String, String>) -> Result<Arc<dyn Catalog>> {
let builder = *self;
Ok(Arc::new(builder.load(name, props).await.unwrap()) as Arc<dyn Catalog>)
}
}

pub fn load(r#type: &str) -> Result<Box<dyn BoxedCatalogBuilder>> {
match r#type {
"rest" => Ok(Box::new(RestCatalogBuilder::default()) as Box<dyn BoxedCatalogBuilder>),
_ => Err(Error::new(
ErrorKind::FeatureUnsupported,
format!("Unsupported catalog type: {}", r#type),
)),
}
}

#[cfg(test)]
mod tests {
use std::collections::HashMap;
use crate::load;

#[tokio::test]
async fn test_load() {
let catalog = load("rest").unwrap();
catalog.load("rest".to_string(), HashMap::from(
[("key".to_string(), "value".to_string())]
)).await.unwrap();
}
}
86 changes: 84 additions & 2 deletions crates/catalog/rest/src/catalog.rs
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,15 @@
//! This module contains the iceberg REST catalog implementation.

use std::collections::HashMap;
use std::future::Future;
use std::str::FromStr;

use async_trait::async_trait;
use iceberg::io::FileIO;
use iceberg::table::Table;
use iceberg::{
Catalog, Error, ErrorKind, Namespace, NamespaceIdent, Result, TableCommit, TableCreation,
TableIdent,
Catalog, CatalogBuilder, Error, ErrorKind, Namespace, NamespaceIdent, Result, TableCommit,
TableCreation, TableIdent,
};
use itertools::Itertools;
use reqwest::header::{
Expand All @@ -44,13 +45,17 @@ use crate::types::{
RenameTableRequest,
};

const REST_CATALOG_PROP_URI: &str = "uri";
const REST_CATALOG_PROP_WAREHOUSE: &str = "warehouse";
const ICEBERG_REST_SPEC_VERSION: &str = "0.14.1";
const CARGO_PKG_VERSION: &str = env!("CARGO_PKG_VERSION");
const PATH_V1: &str = "v1";

/// Rest catalog configuration.
#[derive(Clone, Debug, TypedBuilder)]
pub struct RestCatalogConfig {
#[builder(default, setter(strip_option))]
name: Option<String>,
uri: String,

#[builder(default, setter(strip_option(fallback = warehouse_opt)))]
Expand Down Expand Up @@ -223,6 +228,70 @@ impl RestCatalogConfig {
}
}

/// Builder for [`RestCatalog`].
#[derive(Debug)]
pub struct RestCatalogBuilder(RestCatalogConfig);

impl Default for RestCatalogBuilder {
fn default() -> Self {
Self(RestCatalogConfig {
name: None,
uri: "".to_string(),
warehouse: None,
props: HashMap::new(),
client: None,
})
}
}

impl CatalogBuilder for RestCatalogBuilder {
type C = RestCatalog;

fn load(mut self, name: impl Into<String>, props: HashMap<String, String>) -> impl Future<Output=Result<Self::C>> {
self.0.name = Some(name.into());
if props.contains_key(REST_CATALOG_PROP_URI) {
self.0.uri = props
.get(REST_CATALOG_PROP_URI)
.cloned()
.unwrap_or_default();
}

if props.contains_key(REST_CATALOG_PROP_WAREHOUSE) {
self.0.warehouse = props
.get(REST_CATALOG_PROP_WAREHOUSE)
.cloned()
.map(|s| s.into());
}

let result = {
if self.0.name.is_none() {
Err(Error::new(
ErrorKind::DataInvalid,
"Catalog name is required",
))
} else if self.0.uri.is_empty() {
Err(Error::new(
ErrorKind::DataInvalid,
"Catalog uri is required",
))
} else {
Ok(RestCatalog::new(self.0))
}
};

std::future::ready(result)

}
}

impl RestCatalogBuilder {
/// Configures the catalog with a custom HTTP client.
pub fn with_client(&mut self, client: Client) -> &mut Self {
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cc @Xuanwo

self.0.client = Some(client);
self
}
}

#[derive(Debug)]
struct RestContext {
client: HttpClient,
Expand Down Expand Up @@ -2257,4 +2326,17 @@ mod tests {
config_mock.assert_async().await;
update_table_mock.assert_async().await;
}

#[tokio::test]
async fn test_create_rest_catalog() {
let mut builder = RestCatalogBuilder::default();
builder.with_client(Client::new());

let catalog = builder.load("test", HashMap::from([
("uri".to_string(), "http://localhost:8080".to_string()),
("a".to_string(), "b".to_string()),
])).await;

assert!(catalog.is_ok());
}
}
9 changes: 9 additions & 0 deletions crates/iceberg/src/catalog/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@

use std::collections::HashMap;
use std::fmt::{Debug, Display};
use std::future::Future;
use std::mem::take;
use std::ops::Deref;

Expand Down Expand Up @@ -96,6 +97,14 @@ pub trait Catalog: Debug + Sync + Send {
async fn update_table(&self, commit: TableCommit) -> Result<Table>;
}

/// Common interface for all catalog builders.
pub trait CatalogBuilder: Default + Debug + Send + Sync {
/// The catalog type that this builder creates.
type C: Catalog;
/// Create a new catalog instance.
fn load(self, name: impl Into<String>, props: HashMap<String, String>) -> impl Future<Output = Result<Self::C>> + Send;
}

/// NamespaceIdent represents the identifier of a namespace in the catalog.
///
/// The namespace identifier is a list of strings, where each string is a
Expand Down
5 changes: 1 addition & 4 deletions crates/iceberg/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -62,10 +62,7 @@ pub use error::{Error, ErrorKind, Result};

mod catalog;

pub use catalog::{
Catalog, Namespace, NamespaceIdent, TableCommit, TableCreation, TableIdent, TableRequirement,
TableUpdate, ViewCreation,
};
pub use catalog::*;

pub mod table;

Expand Down
Loading