Skip to content

Commit 2437e03

Browse files
authored
docs: fix broken catalog example links (#18765)
## Which issue does this PR close? Related to #18142 and #18743 ## Rationale for this change The catalog examples were moved under `datafusion-examples/examples/data_io/`, but the doc comments and user guide still point to the old paths. This leaves readers with 404s when they try to follow the examples, so the links need to be corrected. ## What changes are included in this PR? Correct the catalog example links so they point to the examples/data_io directory.
1 parent e5b6d97 commit 2437e03

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed

datafusion/catalog/src/async.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@ impl CatalogProviderList for ResolvedCatalogProviderList {
193193
///
194194
/// See the [remote_catalog.rs] for an end to end example
195195
///
196-
/// [remote_catalog.rs]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/remote_catalog.rs
196+
/// [remote_catalog.rs]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/data_io/remote_catalog.rs
197197
#[async_trait]
198198
pub trait AsyncSchemaProvider: Send + Sync {
199199
/// Lookup a table in the schema provider

datafusion/catalog/src/catalog.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ use datafusion_common::Result;
6161
/// schemas and tables exist.
6262
///
6363
/// [Delta Lake]: https://delta.io/
64-
/// [`remote_catalog`]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/remote_catalog.rs
64+
/// [`remote_catalog`]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/data_io/remote_catalog.rs
6565
///
6666
/// The [`CatalogProvider`] can support this use case, but it takes some care.
6767
/// The planning APIs in DataFusion are not `async` and thus network IO can not
@@ -100,7 +100,7 @@ use datafusion_common::Result;
100100
///
101101
/// [`datafusion-cli`]: https://datafusion.apache.org/user-guide/cli/index.html
102102
/// [`DynamicFileCatalogProvider`]: https://github.com/apache/datafusion/blob/31b9b48b08592b7d293f46e75707aad7dadd7cbc/datafusion-cli/src/catalog.rs#L75
103-
/// [`catalog.rs`]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/catalog.rs
103+
/// [`catalog.rs`]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/data_io/catalog.rs
104104
/// [delta-rs]: https://github.com/delta-io/delta-rs
105105
/// [`UnityCatalogProvider`]: https://github.com/delta-io/delta-rs/blob/951436ecec476ce65b5ed3b58b50fb0846ca7b91/crates/deltalake-core/src/data_catalog/unity/datafusion.rs#L111-L123
106106
///

docs/source/library-user-guide/catalogs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919

2020
# Catalogs, Schemas, and Tables
2121

22-
This section describes how to create and manage catalogs, schemas, and tables in DataFusion. For those wanting to dive into the code quickly please see the [example](https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/catalog.rs).
22+
This section describes how to create and manage catalogs, schemas, and tables in DataFusion. For those wanting to dive into the code quickly please see the [example](https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/data_io/catalog.rs).
2323

2424
## General Concepts
2525

0 commit comments

Comments
 (0)