Improve EnforceSorting docs. #14673
Merged
Improve EnforceSorting docs. #14673
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
physical-expr
wiedld
commented
Feb 14, 2025
alamb
approved these changes
Feb 14, 2025
| /// A node context object beneficial for writing optimizer rules. | ||
| /// This context encapsulating an [`ExecutionPlan`] node with a payload. | ||
| /// | ||
| /// Since each wrapped node has it's children within both the [`PlanContext.plan.children()`], |
There was a problem hiding this comment.
👍
this is indeed quite subtle -- it would be awesome if we could find some way to make it harder to forget to call update_plan_from_children
github-actions
bot
removed
the
documentation
alamb
approved these changes
Feb 15, 2025
| /// whether we elect to transform [`CoalescePartitionsExec`] + [`SortExec`] cascades | ||
| /// into [`SortExec`] + [`SortPreservingMergeExec`] cascades, which enables us to | ||
| /// perform sorting in parallel. | ||
| /// Performs optimizations based upon a series of subrules. |
| /// sort first on a per-partition basis, thereby parallelizing the sort. | ||
| /// | ||
| /// | ||
| /// The outcome is that plans of the form |
github-actions
bot
removed
the
documentation
alamb
approved these changes
Feb 16, 2025
| fn update_sort_ctx_children_data( | ||
| mut node: PlanWithCorrespondingSort, | ||
| mut node_and_ctx: PlanWithCorrespondingSort, |
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?
Rationale for this change
update_plan_from_childrencall fromEnforceSorting#14650, that some of the EnforceSorting docs could be improved.What changes are included in this PR?
Only docs. No code.
Are these changes tested?
N/A
Are there any user-facing changes?
N/A