Skip to content

minor: Add link to example for AsyncSchemaProvider #14062

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Jan 12, 2025
Merged

minor: Add link to example for AsyncSchemaProvider #14062

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7c9fc39
minor: Add link to example in catalog
alamb Jan 9, 2025
d2bdc2b
Merge remote-tracking branch 'apache/main' into alamb/doc_link
alamb Jan 10, 2025
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
6 changes: 6 additions & 0 deletions datafusion/catalog/src/async.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,6 +190,10 @@ impl CatalogProviderList for ResolvedCatalogProviderList {
/// After implementing this trait you can call the [`AsyncSchemaProvider::resolve`] method to get an
/// `Arc<dyn SchemaProvider>` that contains a cached copy of the referenced tables. The `resolve`
/// method can be slow and asynchronous as it is only called once, before planning.
///
/// See the [remote_catalog.rs] for an end to end example
///
/// [remote_catalog.rs]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/remote_catalog.rs
#[async_trait]
pub trait AsyncSchemaProvider: Send + Sync {
/// Lookup a table in the schema provider
Expand All @@ -202,6 +206,8 @@ pub trait AsyncSchemaProvider: Send + Sync {
///
/// This cache is intended to be short-lived for the execution of a single query. There is no mechanism
/// for refresh or eviction of stale entries.
///
/// See the [`AsyncSchemaProvider`] documentation for additional details
async fn resolve(
&self,
references: &[TableReference],
Expand Down
Loading