You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@arrow.apache.org by "alamb (via GitHub)" <gi...@apache.org> on 2024/01/23 15:56:34 UTC

[PR] Minor: improve CatalogProvider documentation with rationale and info about remote catalogs [arrow-datafusion]

alamb opened a new pull request, #8968:
URL: https://github.com/apache/arrow-datafusion/pull/8968

   ## Which issue does this PR close?
   
   related to #7013 
   
   ## Rationale for this change
   
   The topic about how to implement remote catalogs has come up several times (most recently in https://github.com/apache/arrow-datafusion/discussions/8887) so it would be good to update the docs to provide more detail
   
   ## What changes are included in this PR?
   
   1. Improve docstrings for various catalog related traits
   2. Add background, examples, and notes on how to implement a remote catalog to [`CatalogProvider`]
   
   ## Are these changes tested?
   covered by CI tests
   <!--
   We typically require tests for all PRs in order to:
   1. Prevent the code from being accidentally broken by subsequent changes
   3. Serve as another way to document the expected behavior of the code
   
   If tests are not included in your PR, please explain why (for example, are they covered by existing tests)?
   -->
   
   ## Are there any user-facing changes?
   Better docs
   <!--
   If there are user-facing changes then we may require documentation to be updated before approving the PR.
   -->
   
   <!--
   If there are any breaking changes to public APIs, please add the `api change` label.
   -->
   


-- 
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: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Minor: improve CatalogProvider documentation with rationale and info about remote catalogs [arrow-datafusion]

Posted by "comphead (via GitHub)" <gi...@apache.org>.
comphead commented on code in PR #8968:
URL: https://github.com/apache/arrow-datafusion/pull/8968#discussion_r1467119832


##########
datafusion/core/src/catalog/mod.rs:
##########
@@ -29,7 +29,10 @@ use datafusion_common::{exec_err, not_impl_err, DataFusionError, Result};
 use std::any::Any;
 use std::sync::Arc;
 
-/// Represent a list of named catalogs
+/// Represent a list of named [`CatalogProvider`]s.
+///
+/// Please see the documentation on `CatalogProvider` for details of
+/// implementing a custom catalog.
 pub trait CatalogList: Sync + Send {

Review Comment:
   Filed https://github.com/apache/arrow-datafusion/pull/9002



-- 
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: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Minor: improve CatalogProvider documentation with rationale and info about remote catalogs [arrow-datafusion]

Posted by "comphead (via GitHub)" <gi...@apache.org>.
comphead merged PR #8968:
URL: https://github.com/apache/arrow-datafusion/pull/8968


-- 
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: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Minor: improve CatalogProvider documentation with rationale and info about remote catalogs [arrow-datafusion]

Posted by "comphead (via GitHub)" <gi...@apache.org>.
comphead commented on code in PR #8968:
URL: https://github.com/apache/arrow-datafusion/pull/8968#discussion_r1464114449


##########
datafusion/core/src/catalog/mod.rs:
##########
@@ -29,7 +29,10 @@ use datafusion_common::{exec_err, not_impl_err, DataFusionError, Result};
 use std::any::Any;
 use std::sync::Arc;
 
-/// Represent a list of named catalogs
+/// Represent a list of named [`CatalogProvider`]s.
+///
+/// Please see the documentation on `CatalogProvider` for details of
+/// implementing a custom catalog.
 pub trait CatalogList: Sync + Send {

Review Comment:
   perhaps CatalogProviderList will be a better name? I can do this in following PR



-- 
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: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org