Add close method to RecordBatchWriter trait #4228
Merged
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
…, JSON, IPC and Parquet
github-actions
bot
added
arrow
tustvold
reviewed
May 16, 2023
arrow-array/src/record_batch.rs
Outdated
| @@ -47,6 +47,9 @@ pub trait RecordBatchReader: Iterator<Item = Result<RecordBatch, ArrowError>> { | |||
| pub trait RecordBatchWriter { | |||
| /// Write a single batch to the writer. | |||
| fn write(&mut self, batch: &RecordBatch) -> Result<(), ArrowError>; | |||
|
|
|||
| /// Write footer or termination data, then mark the writer as done. | |||
| fn finish(self) -> Result<(), ArrowError>; | |||
There was a problem hiding this comment.
Suggested change
| fn finish(self) -> Result<(), ArrowError>; | |
| fn close(self) -> Result<(), ArrowError>; |
Perhaps, this might avoid the name collisions?
alexandreyc
changed the title
Co-authored-by: Raphael Taylor-Davies <[email protected]>
|
Should be good now! Thank you for your review. |
tustvold
approved these changes
May 16, 2023
tustvold
changed the title
|
For those following along, RecordBatchWriter hasn't yet been released so not marking as a breaking change |
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?
This PR does not close any particular issue. It is an alternative implementation of #4221
Rationale for this change
In #4221, the
finishmethod takes&mut selfwhereas in this PR it takesself.We are forced to use fully qualified method calls for
finishwhere we want to callfinishon the object itself becauseRecordBatchWriteris in scope (because weuse arrow_array::*). What's your opinion on importing only needed items fromarrow_arrayto avoid this?What changes are included in this PR?
Add
finishmethod toRecordBatchWriterand implement it for CSV, JSON, IPC and Parquet writers.Are there any user-facing changes?
According to my analysis no breaking change is introduced in this PR.