Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor: Document LogicalPlan tree node transformations #10010

Merged
merged 5 commits into from
Apr 10, 2024

Conversation

alamb
Copy link
Contributor

@alamb alamb commented Apr 9, 2024

Which issue does this PR close?

Part of #9994

Rationale for this change

Part of working with optimizers / LogicalPlans is understanding how to rewrite them and visit them

We are improving this in #8913, so I wanted to make sure the feature is well documented.

What changes are included in this PR?

  1. Add doc comments and pointers about using the LogicalPlan tree node api

Screenshot 2024-04-09 at 7 35 27 AM

Are these changes tested?

Yes, by CI checks

Are there any user-facing changes?

Better docs

TODO:
2. Document apply_subqueries /map_subqueries: #9998

@github-actions github-actions bot added logical-expr Logical plan and expressions core Core DataFusion crate labels Apr 9, 2024
@alamb alamb force-pushed the alamb/logical_plan_rewrite_docs branch from 6bea98c to 68277a1 Compare April 9, 2024 11:33
@alamb alamb added the documentation Improvements or additions to documentation label Apr 9, 2024
@alamb alamb force-pushed the alamb/logical_plan_rewrite_docs branch from 68277a1 to 93cb18e Compare April 9, 2024 11:45
@github-actions github-actions bot removed the documentation Improvements or additions to documentation label Apr 9, 2024
@alamb alamb added the documentation Improvements or additions to documentation label Apr 9, 2024
@alamb alamb changed the title Document LogicalPlan tree node transformations Minor: Document LogicalPlan tree node transformations Apr 9, 2024
Copy link
Member

@andygrove andygrove left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thansk @alamb. This is very helpful, especially now that we have so much functionality in this area.

@github-actions github-actions bot removed the documentation Improvements or additions to documentation label Apr 10, 2024
@alamb
Copy link
Contributor Author

alamb commented Apr 10, 2024

Thanks for the review @andygrove -- I added 2 more functions to the list.

@alamb
Copy link
Contributor Author

alamb commented Apr 10, 2024

🚀 📖

@alamb alamb merged commit 5820507 into apache:main Apr 10, 2024
24 checks passed
@alamb alamb deleted the alamb/logical_plan_rewrite_docs branch April 10, 2024 10:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core Core DataFusion crate logical-expr Logical plan and expressions
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants