alamb commented on code in PR #9520:
URL: https://github.com/apache/arrow-datafusion/pull/9520#discussion_r1518615152
##########
datafusion/core/src/lib.rs:
##########
@@ -145,7 +145,7 @@
//! * define your own catalogs, schemas, and table lists ([`CatalogProvider`])
//! * build your own query language or plans ([`LogicalPlanBuilder`])
//! * declare and use user-defined functions ([`ScalarUDF`], and
[`AggregateUDF`], [`WindowUDF`])
-//! * add custom optimizer rewrite passes ([`OptimizerRule`] and
[`PhysicalOptimizerRule`])
+//! * add custom plan rewrite passes ([`AnalyzerRule`], [`OptimizerRule`] and
[`PhysicalOptimizerRule`])
Review Comment:
contribution 1: Mention `AnalyzerRule` in this list
##########
datafusion/core/src/physical_optimizer/optimizer.rs:
##########
@@ -34,8 +34,12 @@ use
crate::physical_optimizer::topk_aggregation::TopKAggregation;
use crate::{error::Result, physical_plan::ExecutionPlan};
/// `PhysicalOptimizerRule` transforms one ['ExecutionPlan'] into another which
-/// computes the same results, but in a potentially more efficient
-/// way.
+/// computes the same results, but in a potentially more efficient way.
+///
+/// Use [`SessionState::add_physical_optimizer_rule`] to register additional
+/// `PhysicalOptimizerRule`s..
+///
+/// [`SessionState::add_physical_optimizer_rule`]:
https://docs.rs/datafusion/latest/datafusion/execution/context/struct.SessionState.html#method.add_physical_optimizer_rule
Review Comment:
Contrbution 2: Add links to how to register these rules with SessionContext
(which was the API I didn't find initially)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
