Skip to content

Commit

Permalink
Minor: improve Analyzer docs (#13798)
Browse files Browse the repository at this point in the history
  • Loading branch information
alamb authored Dec 16, 2024
1 parent fe53eaf commit 174e08b
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions datafusion/optimizer/src/analyzer/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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.
///
Expand All @@ -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
Expand Down

0 comments on commit 174e08b

Please sign in to comment.