alamb commented on code in PR #4095: URL: https://github.com/apache/arrow-datafusion/pull/4095#discussion_r1013298691
########## datafusion/core/src/catalog/listing_schema.rs: ########## @@ -0,0 +1,145 @@ +// 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. + +//! listing_schema contains a SchemaProvider that scans ObjectStores for tables automatically +use crate::catalog::schema::SchemaProvider; +use crate::datasource::datasource::TableProviderFactory; +use crate::datasource::TableProvider; +use datafusion_common::DataFusionError; +use futures::TryStreamExt; +use object_store::ObjectStore; +use std::any::Any; +use std::collections::{HashMap, HashSet}; +use std::path::Path; +use std::sync::{Arc, Mutex}; + +/// A SchemaProvider that scans an ObjectStore to automatically discover tables +pub struct ListingSchemaProvider { Review Comment: It might make sense to add some documents here about the assumptions this class makes. Like that it assumes each directory in `path` corresponds to a table, for example ########## datafusion/core/src/catalog/listing_schema.rs: ########## @@ -0,0 +1,145 @@ +// 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. + +//! listing_schema contains a SchemaProvider that scans ObjectStores for tables automatically +use crate::catalog::schema::SchemaProvider; +use crate::datasource::datasource::TableProviderFactory; +use crate::datasource::TableProvider; +use datafusion_common::DataFusionError; +use futures::TryStreamExt; +use object_store::ObjectStore; +use std::any::Any; +use std::collections::{HashMap, HashSet}; +use std::path::Path; +use std::sync::{Arc, Mutex}; + +/// A SchemaProvider that scans an ObjectStore to automatically discover tables +pub struct ListingSchemaProvider { + authority: String, + path: object_store::path::Path, + factory: Arc<dyn TableProviderFactory>, + store: Arc<dyn ObjectStore>, + tables: Arc<Mutex<HashMap<String, Arc<dyn TableProvider>>>>, +} + +impl ListingSchemaProvider { + /// Create a new ListingSchemaProvider + pub fn new( + authority: String, Review Comment: Can you please document these parameters? Specifically, I am not sure what `authority` means / is for I assume `path` is the root path for which to search for tables ########## datafusion/core/src/catalog/listing_schema.rs: ########## @@ -0,0 +1,145 @@ +// 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. + +//! listing_schema contains a SchemaProvider that scans ObjectStores for tables automatically +use crate::catalog::schema::SchemaProvider; +use crate::datasource::datasource::TableProviderFactory; +use crate::datasource::TableProvider; +use datafusion_common::DataFusionError; +use futures::TryStreamExt; +use object_store::ObjectStore; +use std::any::Any; +use std::collections::{HashMap, HashSet}; +use std::path::Path; +use std::sync::{Arc, Mutex}; + +/// A SchemaProvider that scans an ObjectStore to automatically discover tables +pub struct ListingSchemaProvider { + authority: String, + path: object_store::path::Path, + factory: Arc<dyn TableProviderFactory>, + store: Arc<dyn ObjectStore>, + tables: Arc<Mutex<HashMap<String, Arc<dyn TableProvider>>>>, +} + +impl ListingSchemaProvider { + /// Create a new ListingSchemaProvider + pub fn new( + authority: String, + path: object_store::path::Path, + factory: Arc<dyn TableProviderFactory>, + store: Arc<dyn ObjectStore>, + ) -> Self { + Self { + authority, + path, + factory, + store, + tables: Arc::new(Mutex::new(HashMap::new())), + } + } + + /// Reload table information from ObjectStore + pub async fn refresh(&self) -> datafusion_common::Result<()> { + let entries: Vec<_> = self + .store + .list(Some(&self.path)) + .await? + .try_collect() + .await?; + let base = Path::new(self.path.as_ref()); + let mut tables = HashSet::new(); + for file in entries.iter() { + let mut parent = Path::new(file.location.as_ref()); + while let Some(p) = parent.parent() { + if p == base { + tables.insert(parent); + } + parent = p; + } + } + for table in tables.iter() { + let file_name = table + .file_name() + .ok_or_else(|| { + DataFusionError::Internal("Cannot parse file name!".to_string()) + })? + .to_str() + .ok_or_else(|| { + DataFusionError::Internal("Cannot parse file name!".to_string()) + })?; + let path = table.to_str().ok_or_else(|| { + DataFusionError::Internal("Cannot parse file name!".to_string()) + })?; + if !self.table_exist(file_name) { + let path = format!("{}/{}", self.authority, path); + let provider = self.factory.create(path.as_str()).await?; + let _ = self.register_table(file_name.to_string(), provider.clone())?; + } + } + Ok(()) + } +} + +impl SchemaProvider for ListingSchemaProvider { + fn as_any(&self) -> &dyn Any { + self + } + + fn table_names(&self) -> Vec<String> { + self.tables + .lock() + .expect("Can't lock tables") + .keys() + .map(|it| it.to_string()) + .collect() + } + + fn table(&self, name: &str) -> Option<Arc<dyn TableProvider>> { + self.tables + .lock() + .expect("Can't lock tables") + .get(name) + .cloned() + } + + fn register_table( + &self, + name: String, + table: Arc<dyn TableProvider>, + ) -> datafusion_common::Result<Option<Arc<dyn TableProvider>>> { + self.tables + .lock() + .expect("Can't lock tables") + .insert(name, table.clone()); + Ok(Some(table)) + } + + fn deregister_table( + &self, + _name: &str, + ) -> datafusion_common::Result<Option<Arc<dyn TableProvider>>> { + todo!("ListingSchemaProvider::deregister_table") Review Comment: Is this meant to be left as a todo? Perhaps we can return an NotYetImplemented error here instead of panicing ########## datafusion/core/src/catalog/listing_schema.rs: ########## @@ -0,0 +1,145 @@ +// 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. + +//! listing_schema contains a SchemaProvider that scans ObjectStores for tables automatically +use crate::catalog::schema::SchemaProvider; +use crate::datasource::datasource::TableProviderFactory; +use crate::datasource::TableProvider; +use datafusion_common::DataFusionError; +use futures::TryStreamExt; +use object_store::ObjectStore; +use std::any::Any; +use std::collections::{HashMap, HashSet}; +use std::path::Path; +use std::sync::{Arc, Mutex}; + +/// A SchemaProvider that scans an ObjectStore to automatically discover tables +pub struct ListingSchemaProvider { + authority: String, + path: object_store::path::Path, + factory: Arc<dyn TableProviderFactory>, + store: Arc<dyn ObjectStore>, + tables: Arc<Mutex<HashMap<String, Arc<dyn TableProvider>>>>, +} + +impl ListingSchemaProvider { + /// Create a new ListingSchemaProvider + pub fn new( + authority: String, + path: object_store::path::Path, + factory: Arc<dyn TableProviderFactory>, + store: Arc<dyn ObjectStore>, + ) -> Self { + Self { + authority, + path, + factory, + store, + tables: Arc::new(Mutex::new(HashMap::new())), + } + } + + /// Reload table information from ObjectStore + pub async fn refresh(&self) -> datafusion_common::Result<()> { + let entries: Vec<_> = self + .store + .list(Some(&self.path)) + .await? + .try_collect() + .await?; + let base = Path::new(self.path.as_ref()); + let mut tables = HashSet::new(); + for file in entries.iter() { + let mut parent = Path::new(file.location.as_ref()); + while let Some(p) = parent.parent() { + if p == base { + tables.insert(parent); + } + parent = p; + } + } + for table in tables.iter() { + let file_name = table + .file_name() + .ok_or_else(|| { + DataFusionError::Internal("Cannot parse file name!".to_string()) + })? + .to_str() + .ok_or_else(|| { + DataFusionError::Internal("Cannot parse file name!".to_string()) + })?; + let path = table.to_str().ok_or_else(|| { + DataFusionError::Internal("Cannot parse file name!".to_string()) + })?; + if !self.table_exist(file_name) { + let path = format!("{}/{}", self.authority, path); Review Comment: ```suggestion let table_name = table.to_str().ok_or_else(|| { DataFusionError::Internal("Cannot parse file name!".to_string()) })?; if !self.table_exist(file_name) { let table_name = format!("{}/{}", self.authority, path); ``` ########## datafusion/core/src/catalog/listing_schema.rs: ########## @@ -0,0 +1,145 @@ +// 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. + +//! listing_schema contains a SchemaProvider that scans ObjectStores for tables automatically +use crate::catalog::schema::SchemaProvider; +use crate::datasource::datasource::TableProviderFactory; +use crate::datasource::TableProvider; +use datafusion_common::DataFusionError; +use futures::TryStreamExt; +use object_store::ObjectStore; +use std::any::Any; +use std::collections::{HashMap, HashSet}; +use std::path::Path; +use std::sync::{Arc, Mutex}; + +/// A SchemaProvider that scans an ObjectStore to automatically discover tables +pub struct ListingSchemaProvider { + authority: String, + path: object_store::path::Path, + factory: Arc<dyn TableProviderFactory>, + store: Arc<dyn ObjectStore>, + tables: Arc<Mutex<HashMap<String, Arc<dyn TableProvider>>>>, +} + +impl ListingSchemaProvider { + /// Create a new ListingSchemaProvider + pub fn new( + authority: String, + path: object_store::path::Path, + factory: Arc<dyn TableProviderFactory>, + store: Arc<dyn ObjectStore>, + ) -> Self { + Self { + authority, + path, + factory, + store, + tables: Arc::new(Mutex::new(HashMap::new())), + } + } + + /// Reload table information from ObjectStore Review Comment: I recommend documenting here when `refresh()` should be called -- like it has to be called explicitly after construction for example -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
