martin-g commented on code in PR #18657:
URL: https://github.com/apache/datafusion/pull/18657#discussion_r2519802950
##########
datafusion/ffi/src/tests/catalog.rs:
##########
@@ -181,3 +183,55 @@ pub(crate) extern "C" fn create_catalog_provider() ->
FFI_CatalogProvider {
let catalog_provider = Arc::new(FixedCatalogProvider::default());
FFI_CatalogProvider::new(catalog_provider, None)
}
+
+/// This catalog provider list is intended only for unit tests. It
prepopulates with one
+/// catalog and only allows for catalogs named after four colors.
+#[derive(Debug)]
+pub struct FixedCatalogProviderList {
+ inner: MemoryCatalogProviderList,
+}
+
+impl Default for FixedCatalogProviderList {
+ fn default() -> Self {
+ let inner = MemoryCatalogProviderList::new();
+
+ let _ = inner.register_catalog(
+ "blue".to_owned(),
+ Arc::new(FixedCatalogProvider::default()),
+ );
+
+ Self { inner }
+ }
+}
+
+impl CatalogProviderList for FixedCatalogProviderList {
+ fn as_any(&self) -> &dyn Any {
+ self
+ }
+
+ fn catalog_names(&self) -> Vec<String> {
+ self.inner.catalog_names()
+ }
+
+ fn catalog(&self, name: &str) -> Option<Arc<dyn CatalogProvider>> {
+ self.inner.catalog(name)
+ }
+
+ fn register_catalog(
+ &self,
+ name: String,
+ catalog: Arc<dyn CatalogProvider>,
+ ) -> Option<Arc<dyn CatalogProvider>> {
+ if !["blue", "red", "green", "yellow"].contains(&name.as_str()) {
+ log::warn!("FixedCatalogProviderList only provides four schemas:
blue, red, green, yellow");
Review Comment:
```suggestion
log::warn!("FixedCatalogProviderList only provides four
catalogs: blue, red, green, yellow");
```
##########
datafusion/ffi/tests/ffi_catalog.rs:
##########
@@ -0,0 +1,82 @@
+// 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.
+
+/// Add an additional module here for convenience to scope this to only
+/// when the feature integration-tests is built
+#[cfg(feature = "integration-tests")]
+mod tests {
+ use datafusion::prelude::SessionContext;
+ use datafusion_common::DataFusionError;
+ use datafusion_ffi::catalog_provider::ForeignCatalogProvider;
+ use datafusion_ffi::catalog_provider_list::ForeignCatalogProviderList;
+ use datafusion_ffi::tests::utils::get_module;
+ use std::sync::Arc;
+
+ #[tokio::test]
+ async fn test_catalog() -> datafusion_common::Result<()> {
+ let module = get_module()?;
+
+ let ffi_catalog =
+ module
+ .create_catalog()
+ .ok_or(DataFusionError::NotImplemented(
+ "External catalog provider failed to implement
create_catalog"
+ .to_string(),
+ ))?();
+ let foreign_catalog: ForeignCatalogProvider = (&ffi_catalog).into();
+
+ let ctx = SessionContext::default();
+ let _ = ctx.register_catalog("fruit", Arc::new(foreign_catalog));
+
+ let df = ctx.table("fruit.apple.purchases").await?;
+
+ let results = df.collect().await?;
+
+ assert_eq!(results.len(), 2);
+ let num_rows: usize = results.into_iter().map(|rb|
rb.num_rows()).sum();
+ assert_eq!(num_rows, 5);
+
+ Ok(())
+ }
+
+ #[tokio::test]
+ async fn test_catalog_list() -> datafusion_common::Result<()> {
+ let module = get_module()?;
+
+ let ffi_catalog_list =
+ module
+ .create_catalog_list()
+ .ok_or(DataFusionError::NotImplemented(
+ "External catalog provider failed to implement
create_catalog"
Review Comment:
```suggestion
"External catalog provider failed to implement
create_catalog_list"
```
##########
datafusion/ffi/src/catalog_provider_list.rs:
##########
@@ -0,0 +1,283 @@
+// 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::{any::Any, ffi::c_void, sync::Arc};
+
+use abi_stable::{
+ std_types::{ROption, RString, RVec},
+ StableAbi,
+};
+use datafusion::catalog::{CatalogProvider, CatalogProviderList};
+use tokio::runtime::Handle;
+
+use crate::catalog_provider::{FFI_CatalogProvider, ForeignCatalogProvider};
+
+/// A stable struct for sharing [`CatalogProviderList`] across FFI boundaries.
+#[repr(C)]
+#[derive(Debug, StableAbi)]
+#[allow(non_camel_case_types)]
+pub struct FFI_CatalogProviderList {
+ /// Register a catalog
+ pub register_catalog: unsafe extern "C" fn(
+ &Self,
+ name: RString,
+ catalog: &FFI_CatalogProvider,
+ ) -> ROption<FFI_CatalogProvider>,
+
+ /// List of existing catalogs
+ pub catalog_names: unsafe extern "C" fn(&Self) -> RVec<RString>,
+
+ /// Access a catalog
+ pub catalog:
+ unsafe extern "C" fn(&Self, name: RString) ->
ROption<FFI_CatalogProvider>,
+
+ /// Used to create a clone on the provider of the execution plan. This
should
+ /// only need to be called by the receiver of the plan.
+ pub clone: unsafe extern "C" fn(plan: &Self) -> Self,
+
+ /// Release the memory of the private data when it is no longer being used.
+ pub release: unsafe extern "C" fn(arg: &mut Self),
+
+ /// Return the major DataFusion version number of this provider.
+ pub version: unsafe extern "C" fn() -> u64,
+
+ /// Internal data. This is only to be accessed by the provider of the plan.
+ /// A [`ForeignCatalogProviderList`] should never attempt to access this
data.
+ pub private_data: *mut c_void,
+}
+
+unsafe impl Send for FFI_CatalogProviderList {}
+unsafe impl Sync for FFI_CatalogProviderList {}
+
+struct ProviderPrivateData {
+ provider: Arc<dyn CatalogProviderList + Send>,
+ runtime: Option<Handle>,
+}
+
+impl FFI_CatalogProviderList {
+ unsafe fn inner(&self) -> &Arc<dyn CatalogProviderList + Send> {
+ let private_data = self.private_data as *const ProviderPrivateData;
+ &(*private_data).provider
+ }
+
+ unsafe fn runtime(&self) -> Option<Handle> {
+ let private_data = self.private_data as *const ProviderPrivateData;
+ (*private_data).runtime.clone()
+ }
+}
+
+unsafe extern "C" fn catalog_names_fn_wrapper(
+ provider: &FFI_CatalogProviderList,
+) -> RVec<RString> {
+ let names = provider.inner().catalog_names();
+ names.into_iter().map(|s| s.into()).collect()
+}
+
+unsafe extern "C" fn register_catalog_fn_wrapper(
+ provider: &FFI_CatalogProviderList,
+ name: RString,
+ catalog: &FFI_CatalogProvider,
+) -> ROption<FFI_CatalogProvider> {
+ let runtime = provider.runtime();
+ let provider = provider.inner();
+ let catalog = Arc::new(ForeignCatalogProvider::from(catalog));
+
+ provider
+ .register_catalog(name.into(), catalog)
+ .map(|catalog| FFI_CatalogProvider::new(catalog, runtime))
+ .into()
+}
+
+unsafe extern "C" fn catalog_fn_wrapper(
+ provider: &FFI_CatalogProviderList,
+ name: RString,
+) -> ROption<FFI_CatalogProvider> {
+ let runtime = provider.runtime();
+ let provider = provider.inner();
+ provider
+ .catalog(name.as_str())
+ .map(|catalog| FFI_CatalogProvider::new(catalog, runtime))
+ .into()
+}
+
+unsafe extern "C" fn release_fn_wrapper(provider: &mut
FFI_CatalogProviderList) {
+ let private_data = Box::from_raw(provider.private_data as *mut
ProviderPrivateData);
+ drop(private_data);
+}
+
+unsafe extern "C" fn clone_fn_wrapper(
+ provider: &FFI_CatalogProviderList,
+) -> FFI_CatalogProviderList {
+ let old_private_data = provider.private_data as *const ProviderPrivateData;
+ let runtime = (*old_private_data).runtime.clone();
+
+ let private_data = Box::into_raw(Box::new(ProviderPrivateData {
+ provider: Arc::clone(&(*old_private_data).provider),
+ runtime,
+ })) as *mut c_void;
+
+ FFI_CatalogProviderList {
+ register_catalog: register_catalog_fn_wrapper,
+ catalog_names: catalog_names_fn_wrapper,
+ catalog: catalog_fn_wrapper,
+ clone: clone_fn_wrapper,
+ release: release_fn_wrapper,
+ version: super::version,
+ private_data,
+ }
+}
+
+impl Drop for FFI_CatalogProviderList {
+ fn drop(&mut self) {
+ unsafe { (self.release)(self) }
+ }
+}
+
+impl FFI_CatalogProviderList {
+ /// Creates a new [`FFI_CatalogProviderList`].
+ pub fn new(
+ provider: Arc<dyn CatalogProviderList + Send>,
+ runtime: Option<Handle>,
+ ) -> Self {
+ let private_data = Box::new(ProviderPrivateData { provider, runtime });
+
+ Self {
+ register_catalog: register_catalog_fn_wrapper,
+ catalog_names: catalog_names_fn_wrapper,
+ catalog: catalog_fn_wrapper,
+ clone: clone_fn_wrapper,
+ release: release_fn_wrapper,
+ version: super::version,
+ private_data: Box::into_raw(private_data) as *mut c_void,
+ }
+ }
+}
+
+/// This wrapper struct exists on the receiver side of the FFI interface, so
it has
+/// no guarantees about being able to access the data in `private_data`. Any
functions
+/// defined on this struct must only use the stable functions provided in
+/// FFI_CatalogProviderList to interact with the foreign table provider.
Review Comment:
```suggestion
/// FFI_CatalogProviderList to interact with the foreign catalog provider.
```
--
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]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
