Skip to content

Commit 54a5d3f

Browse files
authored
minor: Add link to example in catalog (#14062)
1 parent 2e5c6b2 commit 54a5d3f

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

datafusion/catalog/src/async.rs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -190,6 +190,10 @@ impl CatalogProviderList for ResolvedCatalogProviderList {
190190
/// After implementing this trait you can call the [`AsyncSchemaProvider::resolve`] method to get an
191191
/// `Arc<dyn SchemaProvider>` that contains a cached copy of the referenced tables. The `resolve`
192192
/// method can be slow and asynchronous as it is only called once, before planning.
193+
///
194+
/// See the [remote_catalog.rs] for an end to end example
195+
///
196+
/// [remote_catalog.rs]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/remote_catalog.rs
193197
#[async_trait]
194198
pub trait AsyncSchemaProvider: Send + Sync {
195199
/// Lookup a table in the schema provider
@@ -202,6 +206,8 @@ pub trait AsyncSchemaProvider: Send + Sync {
202206
///
203207
/// This cache is intended to be short-lived for the execution of a single query. There is no mechanism
204208
/// for refresh or eviction of stale entries.
209+
///
210+
/// See the [`AsyncSchemaProvider`] documentation for additional details
205211
async fn resolve(
206212
&self,
207213
references: &[TableReference],

0 commit comments

Comments
 (0)