Skip to content

Commit d111dd0

Browse files
authored
doc: More comments on GroupedHashAggregateStream refactor (apache#23200)
## Which issue does this PR close? <!-- We generally require a GitHub issue to be filed for all bug fixes and enhancements and this helps us generate change logs for our releases. You can link an issue to this PR using the GitHub syntax. For example `Closes apache#123` indicates that this PR will close issue apache#123. --> - Closes #. ## Rationale for this change <!-- Why are you proposing this change? If this is already explained clearly in the issue then this section is not needed. Explaining clearly why changes are proposed helps reviewers understand your changes and offer better suggestions for fixes. --> Original discussion: apache#23165 This PR adds more comments to explain the on-going refactor, to reduce confusion. - refactor: apache#22710 cc @alamb @Rachelint ## What changes are included in this PR? <!-- There is no need to duplicate the description in the issue here but it is sometimes worth providing a summary of the individual changes in this PR. --> ## Are these changes tested? <!-- We typically require tests for all PRs in order to: 1. Prevent the code from being accidentally broken by subsequent changes 2. Serve as another way to document the expected behavior of the code If tests are not included in your PR, please explain why (for example, are they covered by existing tests)? --> ## Are there any user-facing changes? <!-- If there are user-facing changes then we may require documentation to be updated before approving the PR. --> <!-- If there are any breaking changes to public APIs, please add the `api change` label. -->
1 parent bde8e5b commit d111dd0

2 files changed

Lines changed: 18 additions & 1 deletion

File tree

datafusion/physical-plan/src/aggregates/mod.rs

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1009,6 +1009,13 @@ impl AggregateExec {
10091009
));
10101010
}
10111011

1012+
// `GroupedHashAggregateStream` is being incrementally refactored. See the
1013+
// tracking issue for details.
1014+
//
1015+
// New features and improvements should go directly into the new implementation.
1016+
// Please coordinate through the tracking issue.
1017+
//
1018+
// Issue: <https://github.com/apache/datafusion/issues/22710>
10121019
if context
10131020
.session_config()
10141021
.options()
@@ -1028,7 +1035,7 @@ impl AggregateExec {
10281035
}
10291036
}
10301037

1031-
// grouping by something else and we need to just materialize all results
1038+
// Execution paths that have not been migrated use the fallback implementation
10321039
Ok(StreamType::GroupedHash(GroupedHashAggregateStream::new(
10331040
self, context, partition,
10341041
)?))

datafusion/physical-plan/src/aggregates/row_hash.rs

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,16 @@ enum OutOfMemoryMode {
132132

133133
/// HashTable based Grouping Aggregator
134134
///
135+
/// # Development Note
136+
///
137+
/// This implementation is being incrementally refactored. See the tracking issue
138+
/// for details.
139+
///
140+
/// New features and improvements should go directly into the new implementation.
141+
/// Please coordinate through the tracking issue.
142+
///
143+
/// Issue: <https://github.com/apache/datafusion/issues/22710>
144+
///
135145
/// # Design Goals
136146
///
137147
/// This structure is designed so that updating the aggregates can be

0 commit comments

Comments
 (0)