GH-37042: [MATLAB] Implement Feather V1 Writer using new MATLAB Interface APIs #37043

sgilmore10 · 2023-08-07T18:23:45Z

Rationale for this change

Now that we've have the basic building blocks for tabular IO in the MATLAB Interface (Array, Schema, RecordBatch), we can implement a Feather V1 writer in terms of the new APIs.

This is the first in a series of pull requests in which we will work on replacing the legacy feather V1 infrastructure with a new implementation that use the MATLAB Interface APIs. A side effect of doing this work is that we can eventually delete a lot of legacy build infrastructure and code.

What changes are included in this PR?

Added a new class called arrow.internal.io.feather.Writer which can be used to write feather V1 files. It has one public property named Filename and one public method write.

Below is an example of its usage:

>> T = table([1; 2; 3], single([10; 11; 12]));

T =

  3×2 table

    Var1    Var2
    ____    ____

     1       10 
     2       11 
     3       12 

>> filename = "/tmp/table.feather";
>> writer = arrow.internal.io.feather.Writer(filename)

writer = 

  Writer with properties:

    Filename: "/tmp/table.feather"

>> writer.write(T);

Added an unwrap method to proxy::RecordBatch so that the FeatherWriter::write method can access the underlying RecordBatch from the proxy.
Changed the SetAccess and GetAccess of the Proxy property on arrow.tabular.RecordBatch to private and public, respectively.

Are these changes tested?

Yes, added a new test file called tRoundTrip.m in the matlab/test/arrow/io/feather folder.

Are there any user-facing changes?

No.

Future Directions

Add a new class for reading feather V1 files (See [MATLAB] Implement Feather V1 Reader using new MATLAB Interface APIs #37041).
Integrate this class in the public featherwrite function.
Once this class is integrated with featherwrite, we can delete the legacy build infrastructure and source code.

Closes: [MATLAB] Implement Feather V1 Writer using new MATLAB Interface APIs #37042

matlab/src/cpp/arrow/matlab/io/feather/proxy/feather_writer.cc

matlab/src/cpp/arrow/matlab/io/feather/proxy/feather_writer.h

matlab/src/matlab/+arrow/+internal/+io/+feather/Writer.m

matlab/test/arrow/io/feather/tRoundTrip.m

sgilmore10 · 2023-08-07T19:04:27Z

The Dev / Lint job failed due to the an issue in /arrow/cpp/src/arrow/acero/aggregate_internal.h. Not related to my changes.

kevingurney · 2023-08-07T19:21:13Z

+1

…face APIs (#37044) ### Rationale for this change Now that we've have the basic building blocks for tabular IO in the MATLAB Interface (Array, Schema, RecordBatch), we can implement a Feather V1 reader in terms of the new APIs. This is a follow up to #37043, where a new Feather V1 internal `Writer` object was added. ### What changes are included in this PR? 1. Added a new class called arrow.internal.io.feather.Reader which can be used to read Feather V1 files. It has one public property named `Filename` and one public method named `read`. **Example Usage:** ```matlab >> T = array2table(rand(3)) T = 3x3 table Var1 Var2 Var3 _______ ________ _______ 0.79221 0.035712 0.67874 0.95949 0.84913 0.75774 0.65574 0.93399 0.74313 >> filename = "test.feather"; >> featherwrite(filename, T) >> reader = arrow.internal.io.feather.Reader(filename) reader = Reader with properties: Filename: "test.feather" >> T = reader.read() T = 3x3 table Var1 Var2 Var3 _______ ________ _______ 0.79221 0.035712 0.67874 0.95949 0.84913 0.75774 0.65574 0.93399 0.74313 ``` ### Are these changes tested? Yes. 1. Added `Reader` to `feather/tRoundTrip.m`. ### Are there any user-facing changes? No. These are only internal objects right now. ### Future Directions 1. Re-implement `featherread` in terms of the new `Reader` object. 2. Remove legacy feather code and infrastructure. ### Notes 1. For conciseness, I renamed the C++ Proxy class `FeatherWriter` to `Writer` since it is already inside of a `feather` namespace / "package". * Closes: #37041 Authored-by: Kevin Gurney <kgurney@mathworks.com> Signed-off-by: Kevin Gurney <kgurney@mathworks.com>

…io.feather.Writer (#37047) ### Rationale for this change Now that #37043 is merged, we can re-implement `featherwrite` in terms of the new `arrow.internal.io.feather.Writer` class. Once this change is made, we can delete the legacy build infrastructure and featherwrite MEX code. ### What changes are included in this PR? 1. Re-implemented `featherwrite` using `arrow.internal.io.feather.Writer`. ### Are these changes tested? 1. Yes, the existing tests in `tfeather.m` cover these changes. 2. I had to update some of the expected error message IDs in `tfeather.m` because the new implementation throws errors with different IDs. 3. `featherwrite` used to export the real part of MATLAB complex numeric arrays. The new version of `featherwrite` now errors if the input table contains complex data because feather/Arrow itself does not support complex numeric data. We think this is the right decision. Writing out only the real part is lossy. ### Are there any user-facing changes? Yes, `featherwrite` no longer supports writing complex numeric arrays. ### Future Directions 1. Once this PR is merged, we will remove the legacy build infrastructure and MEX code. * Closes: #37045 Authored-by: Sarah Gilmore <sgilmore@mathworks.com> Signed-off-by: Kevin Gurney <kgurney@mathworks.com>

conbench-apache-arrow · 2023-08-09T16:33:57Z

After merging your PR, Conbench analyzed the 5 benchmarking runs that have been run so far on merge-commit 71329ce.

There were no benchmark performance regressions. 🎉

The full Conbench report has more details. It also includes information about possible false positives for unstable benchmarks that are known to sometimes produce them.

… Interface APIs (apache#37043) ### Rationale for this change Now that we've have the basic building blocks for tabular IO in the MATLAB Interface (`Array`, `Schema`, `RecordBatch`), we can implement a Feather V1 writer in terms of the new APIs. This is the first in a series of pull requests in which we will work on replacing the legacy feather V1 infrastructure with a new implementation that use the MATLAB Interface APIs. A side effect of doing this work is that we can eventually delete a lot of legacy build infrastructure and code. ### What changes are included in this PR? 1. Added a new class called `arrow.internal.io.feather.Writer` which can be used to write feather V1 files. It has one public property named `Filename` and one public method `write`. Below is an example of its usage: ```matlab >> T = table([1; 2; 3], single([10; 11; 12])); T = 3×2 table Var1 Var2 ____ ____ 1 10 2 11 3 12 >> filename = "/tmp/table.feather"; >> writer = arrow.internal.io.feather.Writer(filename) writer = Writer with properties: Filename: "/tmp/table.feather" >> writer.write(T); ``` 2. Added an `unwrap` method to `proxy::RecordBatch` so that the `FeatherWriter::write` method can access the underlying `RecordBatch` from the proxy. 3. Changed the `SetAccess` and `GetAccess` of the `Proxy` property on `arrow.tabular.RecordBatch` to `private` and `public`, respectively. ### Are these changes tested? Yes, added a new test file called `tRoundTrip.m` in the `matlab/test/arrow/io/feather` folder. ### Are there any user-facing changes? No. ### Future Directions 1. Add a new class for reading feather V1 files (See apache#37041). 2. Integrate this class in the public `featherwrite` function. 5. Once this class is integrated with `featherwrite`, we can delete the legacy build infrastructure and source code. * Closes: apache#37042 Authored-by: Sarah Gilmore <sgilmore@mathworks.com> Signed-off-by: Kevin Gurney <kgurney@mathworks.com>

… Interface APIs (apache#37044) ### Rationale for this change Now that we've have the basic building blocks for tabular IO in the MATLAB Interface (Array, Schema, RecordBatch), we can implement a Feather V1 reader in terms of the new APIs. This is a follow up to apache#37043, where a new Feather V1 internal `Writer` object was added. ### What changes are included in this PR? 1. Added a new class called arrow.internal.io.feather.Reader which can be used to read Feather V1 files. It has one public property named `Filename` and one public method named `read`. **Example Usage:** ```matlab >> T = array2table(rand(3)) T = 3x3 table Var1 Var2 Var3 _______ ________ _______ 0.79221 0.035712 0.67874 0.95949 0.84913 0.75774 0.65574 0.93399 0.74313 >> filename = "test.feather"; >> featherwrite(filename, T) >> reader = arrow.internal.io.feather.Reader(filename) reader = Reader with properties: Filename: "test.feather" >> T = reader.read() T = 3x3 table Var1 Var2 Var3 _______ ________ _______ 0.79221 0.035712 0.67874 0.95949 0.84913 0.75774 0.65574 0.93399 0.74313 ``` ### Are these changes tested? Yes. 1. Added `Reader` to `feather/tRoundTrip.m`. ### Are there any user-facing changes? No. These are only internal objects right now. ### Future Directions 1. Re-implement `featherread` in terms of the new `Reader` object. 2. Remove legacy feather code and infrastructure. ### Notes 1. For conciseness, I renamed the C++ Proxy class `FeatherWriter` to `Writer` since it is already inside of a `feather` namespace / "package". * Closes: apache#37041 Authored-by: Kevin Gurney <kgurney@mathworks.com> Signed-off-by: Kevin Gurney <kgurney@mathworks.com>

…ernal.io.feather.Writer (apache#37047) ### Rationale for this change Now that apache#37043 is merged, we can re-implement `featherwrite` in terms of the new `arrow.internal.io.feather.Writer` class. Once this change is made, we can delete the legacy build infrastructure and featherwrite MEX code. ### What changes are included in this PR? 1. Re-implemented `featherwrite` using `arrow.internal.io.feather.Writer`. ### Are these changes tested? 1. Yes, the existing tests in `tfeather.m` cover these changes. 2. I had to update some of the expected error message IDs in `tfeather.m` because the new implementation throws errors with different IDs. 3. `featherwrite` used to export the real part of MATLAB complex numeric arrays. The new version of `featherwrite` now errors if the input table contains complex data because feather/Arrow itself does not support complex numeric data. We think this is the right decision. Writing out only the real part is lossy. ### Are there any user-facing changes? Yes, `featherwrite` no longer supports writing complex numeric arrays. ### Future Directions 1. Once this PR is merged, we will remove the legacy build infrastructure and MEX code. * Closes: apache#37045 Authored-by: Sarah Gilmore <sgilmore@mathworks.com> Signed-off-by: Kevin Gurney <kgurney@mathworks.com>

sgilmore10 added 15 commits August 4, 2023 15:31

Add stub files for feather_writer.cc and feather_writer.h

85b78c3

Add FeatherWriter::make

56beb41

Add arrow.internal.io.feather.Writer class

7fc1906

Register FeatherWriter proxy

72038d3

Add Filename property to Writer

9a5cd5e

Make Proxy property on RecordBatch get-able, but not set-able

74dc904

Add write method to MATLAB Writer

0bc1ae1

Add unwrap to RecordBatch proxy

6d8bbef

Add extracting record batch from ID to writeRecordBatch C++ method

3c4f75a

Add opening file for write

094124b

Convert record batch to table and call WriteTable

665f5aa

Remove stub comments

d7b7d44

Add error id static const variable

6ca5aff

Add basic test for writing feather files

6073fc8

Remove disp statement in test

8ed68c2

sgilmore10 requested review from kevingurney and kou as code owners August 7, 2023 18:23

github-actions bot added Component: MATLAB awaiting review Awaiting review labels Aug 7, 2023