sdd commented on code in PR #503: URL: https://github.com/apache/iceberg-rust/pull/503#discussion_r1699208009
########## crates/catalog/sql/src/catalog.rs: ########## @@ -0,0 +1,842 @@ +// 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. + +use std::borrow::Cow; +use std::collections::HashMap; +use std::time::Duration; + +use async_trait::async_trait; +use iceberg::io::FileIO; +use iceberg::spec::{TableMetadata, TableMetadataBuilder}; +use iceberg::table::Table; +use iceberg::{ + Catalog, Error, ErrorKind, Namespace, NamespaceIdent, Result, TableCommit, TableCreation, + TableIdent, +}; +use sqlx::any::{install_default_drivers, AnyPoolOptions, AnyRow}; +use sqlx::{AnyPool, Row}; +use typed_builder::TypedBuilder; +use uuid::Uuid; + +use crate::error::from_sqlx_error; + +static CATALOG_TABLE_VIEW_NAME: &str = "iceberg_tables"; +static CATALOG_NAME: &str = "catalog_name"; +static TABLE_NAME: &str = "table_name"; +static TABLE_NAMESPACE: &str = "table_namespace"; +static METADATA_LOCATION_PROP: &str = "metadata_location"; +static PREVIOUS_METADATA_LOCATION_PROP: &str = "previous_metadata_location"; +static RECORD_TYPE: &str = "iceberg_type"; +static TABLE_RECORD_TYPE: &str = "TABLE"; + +static NAMESPACE_PROPERTIES_TABLE_NAME: &str = "iceberg_namespace_properties"; +static NAMESPACE_NAME: &str = "namespace"; +static NAMESPACE_PROPERTY_KEY: &str = "property_key"; +static NAMESPACE_PROPERTY_VALUE: &str = "property_value"; + +static MAX_CONNECTIONS: u32 = 10; +static IDLE_TIMEOUT: u64 = 10; +static TEST_BEFORE_ACQUIRE: bool = true; + +/// Sql catalog config +#[derive(Debug, TypedBuilder)] +pub struct SqlCatalogConfig { + uri: String, + name: String, + warehouse: String, + #[builder(default)] + props: HashMap<String, String>, +} + +#[derive(Debug)] +/// Sql catalog implementation. +pub struct SqlCatalog { + name: String, + connection: AnyPool, + fileio: FileIO, + backend: DatabaseType, +} + +#[derive(Debug, PartialEq)] +enum DatabaseType { + PostgreSQL, + MySQL, + SQLite, +} + +impl SqlCatalog { + /// Create new sql catalog instance + pub async fn new(config: SqlCatalogConfig) -> Result<Self> { + install_default_drivers(); + let max_connections: u32 = config + .props + .get("pool.max-connections") + .map(|v| v.parse().unwrap()) + .unwrap_or(MAX_CONNECTIONS); + let idle_timeout: u64 = config + .props + .get("pool.idle-timeout") + .map(|v| v.parse().unwrap()) + .unwrap_or(IDLE_TIMEOUT); + let test_before_acquire: bool = config + .props + .get("pool.test-before-acquire") + .map(|v| v.parse().unwrap()) + .unwrap_or(TEST_BEFORE_ACQUIRE); + + let pool = AnyPoolOptions::new() + .max_connections(max_connections) + .idle_timeout(Duration::from_secs(idle_timeout)) + .test_before_acquire(test_before_acquire) + .connect(&config.uri) + .await + .map_err(from_sqlx_error)?; + + let conn = pool.acquire().await.map_err(from_sqlx_error)?; + + let db_type = match conn.backend_name() { + "PostgreSQL" => DatabaseType::PostgreSQL, + "MySQL" => DatabaseType::MySQL, + "SQLite" => DatabaseType::SQLite, + _ => DatabaseType::SQLite, + }; + + sqlx::query( + &format!("create table if not exists {} ({} varchar(255) not null, {} varchar(255) not null, {} varchar(255) not null, {} varchar(255), {} varchar(255), {} varchar(5), primary key ({}, {}, {}))", + CATALOG_TABLE_VIEW_NAME, + CATALOG_NAME, + TABLE_NAMESPACE, + TABLE_NAME, + METADATA_LOCATION_PROP, + PREVIOUS_METADATA_LOCATION_PROP, + RECORD_TYPE, + CATALOG_NAME, + TABLE_NAMESPACE, + TABLE_NAME), + ) + .execute(&pool) + .await + .map_err(from_sqlx_error)?; + + sqlx::query( + &format!("create table if not exists {} ({} varchar(255) not null, {} varchar(255) not null, {} varchar(255), {} varchar(255), primary key ({}, {}, {}))", + NAMESPACE_PROPERTIES_TABLE_NAME, + CATALOG_NAME, + NAMESPACE_NAME, + NAMESPACE_PROPERTY_KEY, + NAMESPACE_PROPERTY_VALUE, + CATALOG_NAME, + NAMESPACE_NAME, + NAMESPACE_PROPERTY_KEY) + + ) + .execute(&pool) + .await + .map_err(from_sqlx_error)?; + + let file_io = FileIO::from_path(&config.warehouse)? + .with_props(&config.props) + .build()?; + + Ok(SqlCatalog { + name: config.name.to_owned(), + connection: pool, + fileio: file_io, + backend: db_type, + }) + } + /// handle postgres doing things differently + pub async fn execute_statement( + &self, + query: &String, + args: Vec<Option<&String>>, + ) -> Result<Vec<AnyRow>> { + let query_with_placeholders: Cow<str> = if self.backend == DatabaseType::PostgreSQL { + let mut query = query.clone(); + for i in 0..args.len() { + query = query.replacen("?", &format!("${}", i + 1), 1); + } + Cow::Owned(query) + } else { + Cow::Borrowed(query) + }; + + let mut sqlx_query = sqlx::query(&query_with_placeholders); + for arg in args { + sqlx_query = sqlx_query.bind(arg); + } + + sqlx_query + .fetch_all(&self.connection) + .await + .map_err(from_sqlx_error) + } +} + +#[derive(Debug)] +struct TableRef { + table_namespace: String, + table_name: String, + metadata_location: String, + _previous_metadata_location: Option<String>, +} + +fn query_map(row: &AnyRow) -> std::result::Result<TableRef, sqlx::Error> { + Ok(TableRef { + table_namespace: row.try_get(TABLE_NAMESPACE)?, + table_name: row.try_get(TABLE_NAME)?, + metadata_location: row.try_get(METADATA_LOCATION_PROP)?, + _previous_metadata_location: row + .try_get::<String, _>(PREVIOUS_METADATA_LOCATION_PROP) + .map(Some) + .or_else(|err| { + if let sqlx::Error::ColumnDecode { + index: _, + source: _, + } = err + { + Ok(None) + } else { + Err(err) + } + })?, + }) +} + +#[derive(Debug)] +struct NamespacePropRef { + namespace_prop_key: String, + namespace_prop_value: String, +} + +fn query_map_namespace(row: &AnyRow) -> std::result::Result<NamespacePropRef, sqlx::Error> { + Ok(NamespacePropRef { + namespace_prop_key: row.try_get(NAMESPACE_PROPERTY_KEY)?, + namespace_prop_value: row.try_get(NAMESPACE_PROPERTY_VALUE)?, + }) +} + +#[async_trait] +impl Catalog for SqlCatalog { + async fn list_namespaces( + &self, + parent: Option<&NamespaceIdent>, + ) -> Result<Vec<NamespaceIdent>> { + let name = &self.name; + let base_query = format!( + "select distinct {} from {} where {} = ?", + NAMESPACE_NAME, NAMESPACE_PROPERTIES_TABLE_NAME, CATALOG_NAME + ); + + let rows = match parent { + None => { + self.execute_statement(&base_query, vec![Some(&name.to_string())]) + .await? + } + Some(parent) => { + self.execute_statement( + &(base_query + " and " + TABLE_NAMESPACE + " like ?%"), + vec![Some(&name.to_string()), Some(&parent.join("."))], + ) + .await? + } + }; + + let iter = rows.iter().map(|row| row.try_get::<String, _>(0)); + + Ok(iter + .map(|x| { + x.and_then(|y| { + NamespaceIdent::from_strs(y.split('.')) + .map_err(|err| sqlx::Error::Decode(Box::new(err))) + }) + }) + .collect::<std::result::Result<_, sqlx::Error>>() + .map_err(from_sqlx_error)?) + } + + async fn create_namespace( + &self, + namespace: &NamespaceIdent, + properties: HashMap<String, String>, + ) -> Result<Namespace> { + { + let catalog_name = self.name.clone(); + let namespace = namespace.to_url_string(); + + let query_string = format!( + "insert into {} ({}, {}, {}, {}) values (?, ?, ?, ?);", + NAMESPACE_PROPERTIES_TABLE_NAME, + CATALOG_NAME, + NAMESPACE_NAME, + NAMESPACE_PROPERTY_KEY, + NAMESPACE_PROPERTY_VALUE + ); + + if properties.is_empty() { + self.execute_statement(&query_string, vec![ + Some(&catalog_name), + Some(&namespace), + None::<&String>, + None::<&String>, + ]) + .await?; + } else { + for (key, value) in properties.iter() { + self.execute_statement(&query_string, vec![ + Some(&catalog_name), + Some(&namespace), + Some(key), + Some(value), + ]) + .await?; + } + } + } + + Ok(Namespace::with_properties(namespace.clone(), properties)) + } + + async fn get_namespace(&self, namespace: &NamespaceIdent) -> Result<Namespace> { + let catalog_name = self.name.clone(); + let rows = self + .execute_statement( + &format!( + "select {}, {}, {} from {} where {} = ? and {} = ?", + NAMESPACE_NAME, + NAMESPACE_PROPERTY_KEY, + NAMESPACE_PROPERTY_VALUE, + NAMESPACE_PROPERTIES_TABLE_NAME, + CATALOG_NAME, + NAMESPACE_NAME + ), + vec![Some(&catalog_name), Some(&namespace.join("."))], + ) + .await?; + + let properties: HashMap<String, String> = rows + .iter() + .filter_map(|row| query_map_namespace(row).ok()) + .map(|ns| (ns.namespace_prop_key, ns.namespace_prop_value)) + .collect(); + + Ok(Namespace::with_properties(namespace.clone(), properties)) + } + + async fn namespace_exists(&self, namespace: &NamespaceIdent) -> Result<bool> { + let catalog_name = self.name.clone(); + let namespace = namespace.join("."); + let rows = self + .execute_statement( + &format!( + "select {}, {}, {} from {} where {} = ? and {} = ?", + NAMESPACE_NAME, + NAMESPACE_PROPERTY_KEY, + NAMESPACE_PROPERTY_VALUE, + NAMESPACE_PROPERTIES_TABLE_NAME, + CATALOG_NAME, + NAMESPACE_NAME + ), + vec![Some(&catalog_name), Some(&namespace)], + ) + .await?; + let mut iter = rows.iter().map(query_map_namespace); + + Ok(iter.next().is_some()) + } + + async fn update_namespace( + &self, + namespace: &NamespaceIdent, + properties: HashMap<String, String>, + ) -> Result<()> { + let catalog_name = self.name.clone(); + let namespace_name = namespace.join("."); + let exists = self.namespace_exists(namespace).await?; + if !exists { + Err(Error::new( + ErrorKind::Unexpected, + "cannot update namespace that does not exist", + )) + } else { + let current_nsp = self.get_namespace(namespace).await?; + let current_props = current_nsp.properties(); + + for (key, value) in properties { + if current_props.contains_key(&key) { + self.execute_statement( + &format!( + "update {} set {} = ?, {} = ? where {} = ? and {} = ? and {} = ?", + NAMESPACE_PROPERTIES_TABLE_NAME, + NAMESPACE_PROPERTY_KEY, + NAMESPACE_PROPERTY_VALUE, + NAMESPACE_PROPERTY_KEY, + CATALOG_NAME, + NAMESPACE_NAME + ), + vec![ + Some(&key), + Some(&value), + Some(&key), + Some(&catalog_name), + Some(&namespace_name), + ], + ) + .await?; + } else { + self.execute_statement( + &format!( + "insert into {} ({}, {}, {}, {}) values (?, ?, ?, ?)", + NAMESPACE_PROPERTIES_TABLE_NAME, + CATALOG_NAME, + NAMESPACE_NAME, + NAMESPACE_PROPERTY_KEY, + NAMESPACE_PROPERTY_VALUE + ), + vec![ + Some(&catalog_name), + Some(&namespace_name), + Some(&key), + Some(&value), + ], + ) + .await?; + } + } + + Ok(()) + } + } + + async fn drop_namespace(&self, namespace: &NamespaceIdent) -> Result<()> { + let existence = self.namespace_exists(namespace).await?; + if existence { + if let Ok(tbls) = self.list_tables(namespace).await { + if !tbls.is_empty() { + Err(Error::new( + ErrorKind::Unexpected, + format!( + "unable to drop namespace as it contains {} tables", + tbls.len() + ), + )) + } else { + self.execute_statement( + &format!( + "delete from {} where {} = ? and {} = ?", + NAMESPACE_PROPERTIES_TABLE_NAME, CATALOG_NAME, NAMESPACE_NAME + ), + vec![Some(&self.name.clone()), Some(&namespace.join("."))], + ) + .await?; + + Ok(()) + } + } else { + Err(Error::new( + ErrorKind::Unexpected, + "unable to drop namespace", + )) + } + } else { + Err(Error::new( + ErrorKind::Unexpected, + "unable to drop namespace as it does not exist", + )) + } + } + + async fn list_tables(&self, namespace: &NamespaceIdent) -> Result<Vec<TableIdent>> { + let name = self.name.clone(); + let namespace = namespace.join("."); + let rows = self + .execute_statement( + &format!("select {}, {}, {}, {} from {} where {} = ? and {} = ? and ({} = '{}' or {} is null)", + TABLE_NAMESPACE, + TABLE_NAME, + METADATA_LOCATION_PROP, + PREVIOUS_METADATA_LOCATION_PROP, + CATALOG_TABLE_VIEW_NAME, + CATALOG_NAME, + TABLE_NAMESPACE, + RECORD_TYPE, + TABLE_RECORD_TYPE, + RECORD_TYPE), + vec![Some(&name), Some(&namespace)], + ) + .await?; + + let iter = rows.iter().map(query_map); + + Ok(iter + .map(|x| { + x.and_then(|y| { + let namespace = NamespaceIdent::from_strs(y.table_namespace.split('.')) + .map_err(|err| sqlx::Error::Decode(Box::new(err)))?; + Ok(TableIdent::new(namespace, y.table_name)) + }) + }) + .collect::<std::result::Result<_, sqlx::Error>>() + .map_err(from_sqlx_error)?) + } + + async fn table_exists(&self, identifier: &TableIdent) -> Result<bool> { + let catalog_name = self.name.clone(); + let namespace = identifier.namespace().join("."); + let name = identifier.name().to_string(); + let rows = self + .execute_statement( + &format!("select {}, {}, {}, {} from {} where {} = ? and {} = ? and {} = ? and ({} = '{}' or {} is null);", + TABLE_NAMESPACE, + TABLE_NAME, + METADATA_LOCATION_PROP, + PREVIOUS_METADATA_LOCATION_PROP, + CATALOG_TABLE_VIEW_NAME, + CATALOG_NAME, + TABLE_NAMESPACE, + TABLE_NAME, + RECORD_TYPE, + TABLE_RECORD_TYPE, + RECORD_TYPE), + vec![Some(&catalog_name), Some(&namespace), Some(&name)], + ) + .await?; + let mut iter = rows.iter().map(query_map); + + Ok(iter.next().is_some()) + } + + async fn drop_table(&self, identifier: &TableIdent) -> Result<()> { + let catalog_name = self.name.clone(); + let namespace = identifier.namespace().to_url_string(); + let name = identifier.name.to_string(); + + self.execute_statement( + &format!( + "delete from {} where {} = ? and {} = ? and {} = ?", + CATALOG_TABLE_VIEW_NAME, CATALOG_NAME, TABLE_NAMESPACE, TABLE_NAME + ), + vec![Some(&catalog_name), Some(&namespace), Some(&name)], + ) + .await?; + + let table_existence = self.table_exists(identifier).await; + + match table_existence { + Ok(res) => { + if res { + Err(Error::new( + ErrorKind::Unexpected, + "drop table was not successful", + )) + } else { + Ok(()) + } + } + _ => Err(Error::new( + ErrorKind::Unexpected, + "drop table was not successful", + )), + } + } + + async fn load_table(&self, identifier: &TableIdent) -> Result<Table> { + let metadata_location = { + let catalog_name = self.name.clone(); + let namespace = identifier.namespace().to_url_string(); + let name = identifier.name().to_string(); + let row = self + .execute_statement( + &format!("select {}, {}, {}, {} FROM {} where {} = ? and {} = ? and {} = ? and ({} = '{}' or {} is null)", + TABLE_NAMESPACE, + TABLE_NAME, + METADATA_LOCATION_PROP, + PREVIOUS_METADATA_LOCATION_PROP, + CATALOG_TABLE_VIEW_NAME, + CATALOG_NAME, + TABLE_NAMESPACE, + TABLE_NAME, + RECORD_TYPE, + TABLE_RECORD_TYPE, + RECORD_TYPE + ), + vec![Some(&catalog_name), Some(&namespace), Some(&name)], + ) + .await?; + let row = query_map(&row[0]).map_err(from_sqlx_error)?; + row.metadata_location + }; + let file = self.fileio.new_input(&metadata_location)?; + let metadata_content = file.read().await?; + let metadata = serde_json::from_slice::<TableMetadata>(&metadata_content)?; + + let table = Table::builder() + .file_io(self.fileio.clone()) + .identifier(identifier.clone()) + .metadata(metadata) + .build(); + + Ok(table) + } + + async fn create_table( + &self, + namespace: &NamespaceIdent, + creation: TableCreation, + ) -> Result<Table> { + let location = creation.location.as_ref().ok_or(Error::new( + ErrorKind::DataInvalid, + "Table creation with the Sql catalog requires a location.", + ))?; + let name = creation.name.clone(); + + let uuid = Uuid::new_v4(); + let metadata_location = + location.clone() + "/metadata/" + "0-" + &uuid.to_string() + ".metadata.json"; + + let metadata = TableMetadataBuilder::from_table_creation(creation)?.build()?; + + let file = self.fileio.new_output(&metadata_location)?; + + file.write(serde_json::to_vec(&metadata)?.into()).await?; + + { + let catalog_name = self.name.clone(); + let namespace = namespace.to_url_string(); + let name = name.clone(); + let metadata_location = metadata_location.to_string(); + + self.execute_statement( + &format!( + "insert into {} ({}, {}, {}, {}) values (?, ?, ?, ?)", + CATALOG_TABLE_VIEW_NAME, + CATALOG_NAME, + TABLE_NAMESPACE, + TABLE_NAME, + METADATA_LOCATION_PROP + ), + vec![ + Some(&catalog_name), + Some(&namespace), + Some(&name), + Some(&metadata_location), + ], + ) + .await?; + } + + Ok(Table::builder() + .file_io(self.fileio.clone()) + .metadata_location(metadata_location) + .identifier(TableIdent::new(namespace.clone(), name)) + .metadata(metadata) + .build()) + } + + async fn rename_table(&self, src: &TableIdent, dest: &TableIdent) -> Result<()> { + let source_namespace = &src.namespace.to_url_string(); + let source_table = &src.name; + + let destination_namespace = &dest.namespace.to_url_string(); + let destination_table = &dest.name; + + let src_table_exist = self.table_exists(src).await; + let dst_table_exist = self.table_exists(dest).await; + + match (src_table_exist, dst_table_exist) { Review Comment: I was thinking something more like this: ```rust match (src_table_exist, dst_table_exist) { (Ok(true), Ok(false)) => Ok(()) (Ok(_), Ok(true)) => { Err(Error::new( ErrorKind::Unexpected, "failed to rename table as destination already exists", )) } (Ok(false), Ok(_)) => { Err(Error::new( ErrorKind::Unexpected, "failed to rename table as source does not exist", )) } _ => Err(Error::new(ErrorKind::Unexpected, "failed to rename table")), }?; ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: issues-unsubscr...@iceberg.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: issues-unsubscr...@iceberg.apache.org For additional commands, e-mail: issues-h...@iceberg.apache.org
