Minor: Improve comments and errors for ArrowPredicate #5230
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
alamb
force-pushed
the
alamb/row_selection_error
branch
from
bec60b1 to
ec4b04d
Compare
tustvold
approved these changes
Dec 20, 2023
tustvold
reviewed
Dec 20, 2023
| /// returned [`RowSelection`] will be the conjunction of this and | ||
| /// the rows selected by `predicate` | ||
| /// If the [`ParquetRecordBatchReader`] also specified an explicit | ||
| /// [`RowSelection`] in addition to a predicate, `input_selection` will be |
There was a problem hiding this comment.
IIRC you will also get an input_selection if you have multiple predicates, as it will chain them
There was a problem hiding this comment.
I double checked and you are correct. I updated the comments to reflect this detai
alamb
commented
Dec 20, 2023
| let input_rows = maybe_batch.num_rows(); | ||
| let filter = predicate.evaluate(maybe_batch)?; | ||
| // Since user supplied predicate, check error here to catch bugs quickly | ||
| if filter.len() != input_rows { |
There was a problem hiding this comment.
If this doesn't hold true, RowSelection::and_then panics later. Getting a more specific error closer to where the bug happened would have helped me a lot
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?
N/A
Rationale for this change
While debugging apache/datafusion#8600 it took me a while to figure out what was wrong and I think some better comments and error messages would have helped.
What changes are included in this PR?
Encode some invariants in the comments and error messages.
Are there any user-facing changes?
Better docs and error message