This is an automated email from the ASF dual-hosted git repository.
alamb pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/datafusion.git
The following commit(s) were added to refs/heads/main by this push:
new 174e08b415 Minor: improve Analyzer docs (#13798)
174e08b415 is described below
commit 174e08b4152c90c52f6b52980a2e5170247209ec
Author: Andrew Lamb <[email protected]>
AuthorDate: Mon Dec 16 13:27:32 2024 -0500
Minor: improve Analyzer docs (#13798)
---
datafusion/optimizer/src/analyzer/mod.rs | 11 +++++++----
1 file changed, 7 insertions(+), 4 deletions(-)
diff --git a/datafusion/optimizer/src/analyzer/mod.rs
b/datafusion/optimizer/src/analyzer/mod.rs
index a9fd4900b2..f2fd61dfa8 100644
--- a/datafusion/optimizer/src/analyzer/mod.rs
+++ b/datafusion/optimizer/src/analyzer/mod.rs
@@ -52,7 +52,7 @@ pub mod type_coercion;
/// [`AnalyzerRule`]s transform [`LogicalPlan`]s in some way to make
/// the plan valid prior to the rest of the DataFusion optimization process.
///
-/// This is different than an [`OptimizerRule`](crate::OptimizerRule)
+/// `AnalyzerRule`s are different than an
[`OptimizerRule`](crate::OptimizerRule)s
/// which must preserve the semantics of the `LogicalPlan`, while computing
/// results in a more optimal way.
///
@@ -72,10 +72,13 @@ pub trait AnalyzerRule: Debug {
fn name(&self) -> &str;
}
-/// A rule-based Analyzer.
+/// Rule-based Analyzer.
///
-/// An `Analyzer` transforms a `LogicalPlan`
-/// prior to the rest of the DataFusion optimization process.
+/// Applies [`FunctionRewrite`]s and [`AnalyzerRule`]s to transform a
+/// [`LogicalPlan`] in preparation for execution.
+///
+/// For example, the `Analyzer` applies type coercion to ensure the types of
+/// operands match the types required by functions.
#[derive(Clone, Debug)]
pub struct Analyzer {
/// Expr --> Function writes to apply prior to analysis passes
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
