Skip to content

Commit 6c399c2

Browse files
committed
docs changes after moving code around
separate commit for review purposes
1 parent bd1c50d commit 6c399c2

File tree

4 files changed

+8
-20
lines changed

4 files changed

+8
-20
lines changed

datafusion/catalog/src/catalog.rs

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -40,12 +40,10 @@ use datafusion_common::Result;
4040
///
4141
/// To implement a catalog, you implement at least one of the [`CatalogProviderList`],
4242
/// [`CatalogProvider`] and [`SchemaProvider`] traits and register them
43-
/// appropriately the [`SessionContext`].
44-
///
45-
/// [`SessionContext`]: crate::execution::context::SessionContext
43+
/// appropriately in the `SessionContext`.
4644
///
4745
/// DataFusion comes with a simple in-memory catalog implementation,
48-
/// [`MemoryCatalogProvider`], that is used by default and has no persistence.
46+
/// `MemoryCatalogProvider`, that is used by default and has no persistence.
4947
/// DataFusion does not include more complex Catalog implementations because
5048
/// catalog management is a key design choice for most data systems, and thus
5149
/// it is unlikely that any general-purpose catalog implementation will work
@@ -79,12 +77,10 @@ use datafusion_common::Result;
7977
/// access required to read table details (e.g. statistics).
8078
///
8179
/// The pattern that DataFusion itself uses to plan SQL queries is to walk over
82-
/// the query to [find all table references],
80+
/// the query to find all table references,
8381
/// performing required remote catalog in parallel, and then plans the query
8482
/// using that snapshot.
8583
///
86-
/// [find all table references]: resolve_table_references
87-
///
8884
/// # Example Catalog Implementations
8985
///
9086
/// Here are some examples of how to implement custom catalogs:
@@ -135,7 +131,7 @@ pub trait CatalogProvider: Sync + Send {
135131

136132
/// Removes a schema from this catalog. Implementations of this method should return
137133
/// errors if the schema exists but cannot be dropped. For example, in DataFusion's
138-
/// default in-memory catalog, [`MemoryCatalogProvider`], a non-empty schema
134+
/// default in-memory catalog, `MemoryCatalogProvider`, a non-empty schema
139135
/// will only be successfully dropped when `cascade` is true.
140136
/// This is equivalent to how DROP SCHEMA works in PostgreSQL.
141137
///

datafusion/catalog/src/session.rs

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,7 @@ pub trait CatalogSession: Send + Sync {
4747
///
4848
/// This function will error for [`LogicalPlan`]s such as catalog DDL like
4949
/// `CREATE TABLE`, which do not have corresponding physical plans and must
50-
/// be handled by another layer, typically [`SessionContext`].
51-
///
52-
/// [`SessionContext`]: crate::execution::context::SessionContext
50+
/// be handled by another layer, typically the `SessionContext`.
5351
async fn create_physical_plan(
5452
&self,
5553
logical_plan: &LogicalPlan,
@@ -58,17 +56,11 @@ pub trait CatalogSession: Send + Sync {
5856
/// Create a [`PhysicalExpr`] from an [`Expr`] after applying type
5957
/// coercion, and function rewrites.
6058
///
61-
/// Note: The expression is not [simplified] or otherwise optimized: `a = 1
59+
/// Note: The expression is not simplified or otherwise optimized: `a = 1
6260
/// + 2` will not be simplified to `a = 3` as this is a more involved process.
6361
/// See the [expr_api] example for how to simplify expressions.
6462
///
65-
/// # See Also:
66-
/// * [`SessionContext::create_physical_expr`] for a higher-level API
67-
/// * [`create_physical_expr`] for a lower-level API
68-
///
69-
/// [simplified]: datafusion_optimizer::simplify_expressions
7063
/// [expr_api]: https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/expr_api.rs
71-
/// [`SessionContext::create_physical_expr`]: crate::execution::context::SessionContext::create_physical_expr
7264
fn create_physical_expr(
7365
&self,
7466
expr: Expr,

datafusion/catalog/src/table.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -267,7 +267,7 @@ pub trait TableProvider: Sync + Send {
267267
/// See [`DataSinkExec`] for the common pattern of inserting a
268268
/// streams of `RecordBatch`es as files to an ObjectStore.
269269
///
270-
/// [`DataSinkExec`]: crate::physical_plan::insert::DataSinkExec
270+
/// [`DataSinkExec`]: datafusion_physical_plan::insert::DataSinkExec
271271
async fn insert_into(
272272
&self,
273273
_state: &dyn CatalogSession,

datafusion/core/src/datasource/file_format/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ pub trait FileFormatFactory: Sync + Send + GetExt {
6969
/// from the [`TableProvider`]. This helps code re-utilization across
7070
/// providers that support the same file formats.
7171
///
72-
/// [`TableProvider`]: crate::datasource::provider::TableProvider
72+
/// [`TableProvider`]: crate::catalog_api::TableProvider
7373
#[async_trait]
7474
pub trait FileFormat: Send + Sync + fmt::Debug {
7575
/// Returns the table provider as [`Any`](std::any::Any) so that it can be

0 commit comments

Comments
 (0)