From fdbbf079ec531af5179ba7b3f4259fc9d4cd0cb4 Mon Sep 17 00:00:00 2001 From: Andrew Lamb Date: Sun, 14 Dec 2025 06:58:14 -0500 Subject: [PATCH 1/2] Minor: clean up titles and links n extending operators and optimizer pages --- docs/source/library-user-guide/extending-operators.md | 7 +++++-- docs/source/library-user-guide/query-optimizer.md | 9 ++++++--- 2 files changed, 11 insertions(+), 5 deletions(-) diff --git a/docs/source/library-user-guide/extending-operators.md b/docs/source/library-user-guide/extending-operators.md index 5c28d1e670586..0a169531757c2 100644 --- a/docs/source/library-user-guide/extending-operators.md +++ b/docs/source/library-user-guide/extending-operators.md @@ -17,9 +17,12 @@ under the License. --> -# Extending DataFusion's operators: custom LogicalPlan and Execution Plans +# Extending Operators -DataFusion supports extension of operators by transforming logical plan and execution plan through customized [optimizer rules](https://docs.rs/datafusion/latest/datafusion/optimizer/trait.OptimizerRule.html). This section will use the µWheel project to illustrate such capabilities. +DataFusion supports extending operators by transforming [`LogicalPlan`] and [`ExecutionPlan`] through customized [optimizer rules](https://docs.rs/datafusion/latest/datafusion/optimizer/trait.OptimizerRule.html). This section will use the µWheel project to illustrate such capabilities. + +[`logicalplan`]: https://docs.rs/datafusion/latest/datafusion/logical_expr/enum.LogicalPlan.html +[`executionplan`]: https://docs.rs/datafusion/latest/datafusion/physical_plan/trait.ExecutionPlan.html ## About DataFusion µWheel diff --git a/docs/source/library-user-guide/query-optimizer.md b/docs/source/library-user-guide/query-optimizer.md index 6f2d75a97e895..2225a07a242fa 100644 --- a/docs/source/library-user-guide/query-optimizer.md +++ b/docs/source/library-user-guide/query-optimizer.md @@ -17,17 +17,20 @@ under the License. --> -# DataFusion Query Optimizer +# Query Optimizer [DataFusion][df] is an extensible query execution framework, written in Rust, that uses Apache Arrow as its in-memory format. DataFusion has modular design, allowing individual crates to be re-used in other projects. -This crate is a submodule of DataFusion that provides a query optimizer for logical plans, and -contains an extensive set of OptimizerRules that may rewrite the plan and/or its expressions so +Th crate is a submodule of DataFusion that provides a query optimizer for logical plans, and +contains an extensive set of [`OptimizerRule`]s and [`PhysicalOptimizerRules`] that may rewrite the plan and/or its expressions so they execute more quickly while still computing the same result. +[`optimizerrule`]: https://docs.rs/datafusion/latest/datafusion/optimizer/trait.OptimizerRule.html +[`physicaloptimizerrules`]: https://docs.rs/datafusion/latest/datafusion/physical_optimizer/trait.PhysicalOptimizerRule.html + ## Running the Optimizer The following code demonstrates the basic flow of creating the optimizer with a default set of optimization rules From 4076bb49c40bdefcbedd761f1f95f2acecbfe848 Mon Sep 17 00:00:00 2001 From: Andrew Lamb Date: Sun, 14 Dec 2025 07:01:41 -0500 Subject: [PATCH 2/2] tyop --- docs/source/library-user-guide/query-optimizer.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/library-user-guide/query-optimizer.md b/docs/source/library-user-guide/query-optimizer.md index 2225a07a242fa..8ed6593d56203 100644 --- a/docs/source/library-user-guide/query-optimizer.md +++ b/docs/source/library-user-guide/query-optimizer.md @@ -24,7 +24,7 @@ format. DataFusion has modular design, allowing individual crates to be re-used in other projects. -Th crate is a submodule of DataFusion that provides a query optimizer for logical plans, and +This crate is a submodule of DataFusion that provides a query optimizer for logical plans, and contains an extensive set of [`OptimizerRule`]s and [`PhysicalOptimizerRules`] that may rewrite the plan and/or its expressions so they execute more quickly while still computing the same result.