Minor: Encapsulate LeftJoinData into a struct (rather than anonymous enum) and add comments
#8153
Conversation
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
alamb
changed the title
LeftJoinData into a struct (rather than anonymous enum)
alamb
changed the title
LeftJoinData into a struct (rather than anonymous enum)LeftJoinData into a struct (rather than anonymous enum) and add comments
|
@Dandandan or @metesynnada I wonder if you might have time to review this (I am in the process of working on #8130 and am trying to encode my findings in comments) |
alamb
commented
Nov 13, 2023
| @@ -73,7 +73,47 @@ use datafusion_physical_expr::EquivalenceProperties; | |||
| use ahash::RandomState; | |||
| use futures::{ready, Stream, StreamExt, TryStreamExt}; | |||
|
|
|||
| type JoinLeftData = (JoinHashMap, RecordBatch, MemoryReservation); | |||
| /// HashTable and input data for the left (build side) of a join | |||
| struct JoinLeftData { | |||
There was a problem hiding this comment.
The idea is just to document the fields better by using names rather than .0, .1, etc
comphead
approved these changes
Nov 14, 2023
Dandandan
approved these changes
Nov 14, 2023
|
Thank you @alamb |
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 #8130
Rationale for this change
I am going through this code to understand what is happening, and one thing I think would help would be to use names to refer to fields rather than
data.0,data.1, and that could be commentedWhat changes are included in this PR?
JoinDatanon pubLeftJoinDataa struct with named fields and accessorsAre these changes tested?
Existing tests
Are there any user-facing changes?
No, this is entirely internal code refactoring