-
Notifications
You must be signed in to change notification settings - Fork 351
Add delete file index to pyiceberg and support equality delete reads #2255
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
base: main
Are you sure you want to change the base?
Conversation
I noticed that this PR addresses the same issue/feature as the one I was working on in here. However, your implementation is more complete (by supporting reading equality deletes and deletion vectors), so I think it makes sense to move forward with this one instead. (cc: @sungwy, since you reviewed my PR) |
oops, sorry @gabeiglio, I was searching for positional deletes in github search and i didnt see that you were already working on it in that PR. Looks like there are some parts of the PR that is still super useful to get merged, like the validates. |
Yea exactly, should have been more clear on my message, my implementation for DeleteFileIndex was a scope creep to achieve the validation. so now that PR can be only for the validation instead of partition maps, delete file index, etc. :) @kevinjqliu |
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.
Hi @geruh - thanks for working on this PR, and sorry for the delayed review.
I've added some review feedback. Let me know your thoughts!
@sungwy Thanks a lot! I have done the suggested changes, could you take another look at it? |
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.
Hi @rutb327 thank you for continuing to work on the PR!
I've added a few more suggestions after taking longer time reading your implementation and the test suite. Hope you find this helpful!
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.
This is a very comprehensive test suite! I think we could also benefit from introducing some integration tests, because if we get this wrong, we have the potential to introduce data integrity issues to our users.
There are some great examples of integration tests in tests/integration/test_writes/test_writes.py that invokes a set of actions in either Spark or PyIceberg and then reads the result in both to assert that the result is the same through either.
In our case, I think we could set up a spark session and PyIceberg to the same catalog and:
- create a positional delete through PySpark
- read the result in PyIceberg
- read the result in Spark
- assert that the two results are the same
I think it would be good to cover a range of cases as we did in this unit test suite. WDYT?
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 agree we need to catch potential data integrity issues. I’ll look into adding these tests that cover different cases
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 have added some tests, let me know if we should add some more cases.
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.
The tests look good to me @rutb327 - could we resolve the conflict on tests/conftest.py
?
Closes #1210
Summary
This work was primarily done by @rutb327 while I provided guidance!
This PR adds equality delete read support to PyIceberg by implementing the delete file indexing system that matches delete files to data files, mimicking the behavior found in Iceberg Core. With this implementation we are able to index files and now read equality deletes during table scans.
Design details
Delete File Index
The new
DeleteFileIndex
class centralizes handling of all delete file types: positional deletes, equality deletes, and deletion vectors. It organizes deletes by type (equality vs. positional), partition (usingPartitionMap
for spec-aware grouping), and path (for path-specific positional deletes). This enables efficient lookup during table scans, reducing unnecessary delete file processing.Equality Delete support
Equality delete files are loaded as PyArrow Tables with their respective equality ids for the schema and for each we are grouping tables with the same set equality id's to reduce anti join operations.
Testing
Added tests from the core iceberg DeleteFileIndex test suite and added some tests with dummy files. As well as some manual testing with a flink setup.
Are there any user-facing changes?
Yes can read tables with equality deletes