Minor: Improve documentation for registering AnalyzerRule
#9520
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
optimizer
comphead
reviewed
Mar 9, 2024
comphead
reviewed
Mar 9, 2024
comphead
reviewed
Mar 9, 2024
| pub fn add_physical_optimizer_rule( | ||
| mut self, | ||
| optimizer_rule: Arc<dyn PhysicalOptimizerRule + Send + Sync>, | ||
| physical_optimizer_rule: Arc<dyn PhysicalOptimizerRule + Send + Sync>, |
jayzhan211
approved these changes
Mar 10, 2024
alamb
commented
Mar 10, 2024
| @@ -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`]) | |||
There was a problem hiding this comment.
contribution 1: Mention AnalyzerRule in this list
| /// 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 |
There was a problem hiding this comment.
Contrbution 2: Add links to how to register these rules with SessionContext (which was the API I didn't find initially)
Co-authored-by: comphead <comphead@users.noreply.github.com>
alamb
commented
Mar 10, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Which issue does this PR close?
Related to #9519
Rationale for this change
When filing #9519 I didn't think DataFusion allowed registering AnalyzerRules. However, in the middle of filing a ticket requesting we do so, I found
SessionState::add_analyzer_ruleI would like to make this clearer to find in the future
What changes are included in this PR?
Are these changes tested?
Doc tests
Are there any user-facing changes?
Documentation only (no code changes)