-
Notifications
You must be signed in to change notification settings - Fork 1.9k
feat: add ExpressionPlacement enum for optimizer expression placement decisions #20065
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
Merged
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
ee5c89c
feat: add ExpressionPlacement enum for optimizer expression placement…
adriangb 1cb6eff
test: add placement unit tests for GetFieldFunc
adriangb 380117c
update tests
adriangb 9432e87
wrap up logic into function
adriangb bbce58e
update aggregate slt
adriangb e0b5e57
add comment about literals and cse:
adriangb f7a7155
rename
adriangb f168f60
rename MoveTowardsRootNodes -> KeepInPlace
adriangb File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| // Licensed to the Apache Software Foundation (ASF) under one | ||
| // or more contributor license agreements. See the NOTICE file | ||
| // distributed with this work for additional information | ||
| // regarding copyright ownership. The ASF licenses this file | ||
| // to you under the Apache License, Version 2.0 (the | ||
| // "License"); you may not use this file except in compliance | ||
| // with the License. You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, | ||
| // software distributed under the License is distributed on an | ||
| // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| // KIND, either express or implied. See the License for the | ||
| // specific language governing permissions and limitations | ||
| // under the License. | ||
|
|
||
| //! Expression placement information for optimization decisions. | ||
|
|
||
| /// Describes where an expression should be placed in the query plan for | ||
| /// optimal execution. This is used by optimizers to make decisions about | ||
| /// expression placement, such as whether to push expressions down through | ||
| /// projections. | ||
| #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] | ||
| pub enum ExpressionPlacement { | ||
| /// A constant literal value. | ||
| Literal, | ||
| /// A simple column reference. | ||
| Column, | ||
| /// A cheap expression that can be pushed to leaf nodes in the plan. | ||
| /// Examples include `get_field` for struct field access. | ||
| /// Pushing these expressions down in the plan can reduce data early | ||
| /// at low compute cost. | ||
| /// See [`ExpressionPlacement::should_push_to_leaves`] for details. | ||
| MoveTowardsLeafNodes, | ||
| /// An expensive expression that should stay where it is in the plan. | ||
| /// Examples include complex scalar functions or UDFs. | ||
| KeepInPlace, | ||
| } | ||
|
|
||
| impl ExpressionPlacement { | ||
| /// Returns true if the expression can be pushed down to leaf nodes | ||
| /// in the query plan. | ||
| /// | ||
| /// This returns true for: | ||
| /// - [`ExpressionPlacement::Column`]: Simple column references can be pushed down. They do no compute and do not increase or | ||
| /// decrease the amount of data being processed. | ||
| /// A projection that reduces the number of columns can eliminate unnecessary data early, | ||
| /// but this method only considers one expression at a time, not a projection as a whole. | ||
| /// - [`ExpressionPlacement::MoveTowardsLeafNodes`]: Cheap expressions can be pushed down to leaves to take advantage of | ||
| /// early computation and potential optimizations at the data source level. | ||
| /// For example `struct_col['field']` is cheap to compute (just an Arc clone of the nested array for `'field'`) | ||
| /// and thus can reduce data early in the plan at very low compute cost. | ||
| /// It may even be possible to eliminate the expression entirely if the data source can project only the needed field | ||
| /// (as e.g. Parquet can). | ||
| pub fn should_push_to_leaves(&self) -> bool { | ||
| matches!( | ||
| self, | ||
| ExpressionPlacement::Column | ExpressionPlacement::MoveTowardsLeafNodes | ||
| ) | ||
| } | ||
| } |
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -525,15 +525,14 @@ fn merge_consecutive_projections(proj: Projection) -> Result<Transformed<Project | |
| expr.iter() | ||
| .for_each(|expr| expr.add_column_ref_counts(&mut column_referral_map)); | ||
|
|
||
| // If an expression is non-trivial and appears more than once, do not merge | ||
| // If an expression is non-trivial (KeepInPlace) and appears more than once, do not merge | ||
| // them as consecutive projections will benefit from a compute-once approach. | ||
| // For details, see: https://github.com/apache/datafusion/issues/8296 | ||
| if column_referral_map.into_iter().any(|(col, usage)| { | ||
| usage > 1 | ||
| && !is_expr_trivial( | ||
| &prev_projection.expr | ||
| [prev_projection.schema.index_of_column(col).unwrap()], | ||
| ) | ||
| && !prev_projection.expr[prev_projection.schema.index_of_column(col).unwrap()] | ||
| .placement() | ||
| .should_push_to_leaves() | ||
| }) { | ||
| // no change | ||
| return Projection::try_new_with_schema(expr, input, schema).map(Transformed::no); | ||
|
|
@@ -586,11 +585,6 @@ fn merge_consecutive_projections(proj: Projection) -> Result<Transformed<Project | |
| } | ||
| } | ||
|
|
||
| // Check whether `expr` is trivial; i.e. it doesn't imply any computation. | ||
| fn is_expr_trivial(expr: &Expr) -> bool { | ||
| matches!(expr, Expr::Column(_) | Expr::Literal(_, _)) | ||
| } | ||
|
Comment on lines
-589
to
-592
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The point of this PR is to formalize up these hidden assumptions about expressions and let expressions like |
||
|
|
||
| /// Rewrites a projection expression using the projection before it (i.e. its input) | ||
| /// This is a subroutine to the `merge_consecutive_projections` function. | ||
| /// | ||
|
|
||
This file contains hidden or 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
This file contains hidden or 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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this is an interesting callout to consider. There's some version of this that allows the literals to be optimized but "stops" at scalar functions. To consider for another PR...