Support write to buffer api for SerializedFileWriter #7714
Merged
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
etseidl
approved these changes
Jun 19, 2025
|
Thank you @etseidl for review, i also add the reminder docs in latest PR for users who want to write directly. |
alamb
approved these changes
Jun 20, 2025
There was a problem hiding this comment.
Thank you @zhuqi-lucas and @etseidl
I have some more comments about comments 😆 but the code looks great here.
Thank you!
| /// | ||
| /// It is inadvisable to directly write to the underlying writer, doing so | ||
| /// will likely result in a corrupt parquet file | ||
| /// **Warning**: if you write directly to this writer, you will skip |
parquet/src/file/writer.rs
Outdated
|
|
||
| /// Returns a reference to the underlying writer. | ||
| /// | ||
| /// **Warning**: if you write directly to this writer, you will skip |
There was a problem hiding this comment.
Likewise here since it is not possible to write to an immutable buffer we can probably skip this warning
| /// the file footer’s recorded offsets and sizes to diverge from reality, | ||
| /// resulting in an unreadable or corrupted Parquet file. | ||
| /// | ||
| /// If you want to write safely to the underlying writer, use [`Self::write_all`]. |
Co-authored-by: Andrew Lamb <[email protected]>
Thank you @alamb for review, addressed comments and suggestions in latest PR. |
|
8 tasks
Sounds great to include in this release! |
alamb
approved these changes
Jun 20, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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?
Currently, no pub api to support write the internal buffer for SerializedFileWriter, it's very helpful when we want to add low level API for example:
Because that we want to update the buf bytes written, if we use the buf internal file to write, we can't update the internal buf written bytes.
The consistent update for the bytes written metrics is the key for our custom index write.
Rationale for this change
Add API to support write with buf byteswritten updating.
What changes are included in this PR?
Add API to support write with buf byteswritten updating.
Are there any user-facing changes?
No
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 call them out.