forked from apache/arrow
-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
apacheGH-44922: [MATLAB] Add IPC
RecordBatchStreamFileWriter MATLAB…
… class (apache#44925) ### Rationale for this change To enable support for the IPC Streaming format in the MATLAB interface, we should add a `RecordBatchStreamWriter` class. ### What changes are included in this PR? Added `arrow.io.ipc.RecordBatchStreamWriter` class. **Example Usage:** ```matlab >> city = ["Boston" "Seattle" "Denver" "Juno" "Anchorage" "Chicago"]'; >> daylength = duration(["15:17:01" "15:59:16" "14:59:14" "19:21:23" "14:18:24" "15:13:39"])'; >> matlabTable = table(city, daylength, VariableNames=["City", "DayLength"]); >> recordBatch1 = arrow.recordBatch(matlabTable(1:4, :)) >> recordBatch2 = arrow.recordBatch(matlabTable(5:end, :)); >> writer = arrow.io.ipc.RecordBatchStreamWriter("daylight.arrow", recordBatch1.Schema); >> writer.writeRecordBatch(recordBatch1); >> writer.writeRecordBatch(recordBatch2); >> writer.close(); ``` ### Are these changes tested? Yes. I Parameterized the test cases in `test/arrow/io/ipc/tRecordBatchWriter.m` to test the behavior of both `arrow.io.ipc.RecordBatchFileWriter` AND `arrow.io.ipc.RecordBatchStreamWriter`. ### Are there any user-facing changes? Yes. Users can now use `arrow.io.ipc.RecordBatchStreamWriter` to serialize `RecordBatch`es/`Table`s to the Arrow IPC Streaming format. ### Future Directions 1. apache#44923 * GitHub Issue: apache#44922 Lead-authored-by: Sarah Gilmore <[email protected]> Co-authored-by: Sarah Gilmore <[email protected]> Co-authored-by: Kevin Gurney <[email protected]> Co-authored-by: Sutou Kouhei <[email protected]> Signed-off-by: Sarah Gilmore <[email protected]>
- Loading branch information
3 people
authored
Dec 4, 2024
1 parent
ded148c
commit 2b5a802
Showing
12 changed files
with
387 additions
and
145 deletions.
There are no files selected for viewing
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
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
64 changes: 64 additions & 0 deletions
64
matlab/src/cpp/arrow/matlab/io/ipc/proxy/record_batch_stream_writer.cc
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| // Licensed to the Apache Software Foundation (ASF) under one | ||
| // or more contributor license agreements. See the NOTICE file | ||
| // distributed with this work for additional information | ||
| // regarding copyright ownership. The ASF licenses this file | ||
| // to you under the Apache License, Version 2.0 (the | ||
| // "License"); you may not use this file except in compliance | ||
| // with the License. You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, | ||
| // software distributed under the License is distributed on an | ||
| // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| // KIND, either express or implied. See the License for the | ||
| // specific language governing permissions and limitations | ||
| // under the License. | ||
|
|
||
| #include "arrow/matlab/io/ipc/proxy/record_batch_stream_writer.h" | ||
| #include "arrow/io/file.h" | ||
| #include "arrow/ipc/writer.h" | ||
| #include "arrow/matlab/error/error.h" | ||
| #include "arrow/matlab/tabular/proxy/schema.h" | ||
| #include "arrow/util/utf8.h" | ||
|
|
||
| #include "libmexclass/proxy/ProxyManager.h" | ||
|
|
||
| namespace arrow::matlab::io::ipc::proxy { | ||
|
|
||
| RecordBatchStreamWriter::RecordBatchStreamWriter( | ||
| const std::shared_ptr<arrow::ipc::RecordBatchWriter> writer) | ||
| : RecordBatchWriter(std::move(writer)) {} | ||
|
|
||
| libmexclass::proxy::MakeResult RecordBatchStreamWriter::make( | ||
| const libmexclass::proxy::FunctionArguments& constructor_arguments) { | ||
| namespace mda = ::matlab::data; | ||
| using RecordBatchStreamWriterProxy = | ||
| arrow::matlab::io::ipc::proxy::RecordBatchStreamWriter; | ||
| using SchemaProxy = arrow::matlab::tabular::proxy::Schema; | ||
|
|
||
| const mda::StructArray opts = constructor_arguments[0]; | ||
|
|
||
| const mda::StringArray filename_mda = opts[0]["Filename"]; | ||
| const auto filename_utf16 = std::u16string(filename_mda[0]); | ||
| MATLAB_ASSIGN_OR_ERROR(const auto filename_utf8, | ||
| arrow::util::UTF16StringToUTF8(filename_utf16), | ||
| error::UNICODE_CONVERSION_ERROR_ID); | ||
|
|
||
| const mda::TypedArray<uint64_t> arrow_schema_proxy_id_mda = opts[0]["SchemaProxyID"]; | ||
| auto proxy = libmexclass::proxy::ProxyManager::getProxy(arrow_schema_proxy_id_mda[0]); | ||
| auto arrow_schema_proxy = std::static_pointer_cast<SchemaProxy>(proxy); | ||
| auto arrow_schema = arrow_schema_proxy->unwrap(); | ||
|
|
||
| MATLAB_ASSIGN_OR_ERROR(auto output_stream, | ||
| arrow::io::FileOutputStream::Open(filename_utf8), | ||
| error::FAILED_TO_OPEN_FILE_FOR_WRITE); | ||
|
|
||
| MATLAB_ASSIGN_OR_ERROR(auto writer, | ||
| arrow::ipc::MakeStreamWriter(output_stream, arrow_schema), | ||
| "arrow:matlab:MakeFailed"); | ||
|
|
||
| return std::make_shared<RecordBatchStreamWriterProxy>(std::move(writer)); | ||
| } | ||
|
|
||
| } // namespace arrow::matlab::io::ipc::proxy |
35 changes: 35 additions & 0 deletions
35
matlab/src/cpp/arrow/matlab/io/ipc/proxy/record_batch_stream_writer.h
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| // Licensed to the Apache Software Foundation (ASF) under one | ||
| // or more contributor license agreements. See the NOTICE file | ||
| // distributed with this work for additional information | ||
| // regarding copyright ownership. The ASF licenses this file | ||
| // to you under the Apache License, Version 2.0 (the | ||
| // "License"); you may not use this file except in compliance | ||
| // with the License. You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, | ||
| // software distributed under the License is distributed on an | ||
| // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| // KIND, either express or implied. See the License for the | ||
| // specific language governing permissions and limitations | ||
| // under the License. | ||
|
|
||
| #include "arrow/ipc/writer.h" | ||
| #include "arrow/matlab/io/ipc/proxy/record_batch_writer.h" | ||
|
|
||
| #include "libmexclass/proxy/Proxy.h" | ||
|
|
||
| namespace arrow::matlab::io::ipc::proxy { | ||
|
|
||
| class RecordBatchStreamWriter : public RecordBatchWriter { | ||
| public: | ||
| RecordBatchStreamWriter(std::shared_ptr<arrow::ipc::RecordBatchWriter> writer); | ||
|
|
||
| virtual ~RecordBatchStreamWriter() = default; | ||
|
|
||
| static libmexclass::proxy::MakeResult make( | ||
| const libmexclass::proxy::FunctionArguments& constructor_arguments); | ||
| }; | ||
|
|
||
| } // namespace arrow::matlab::io::ipc::proxy |
75 changes: 75 additions & 0 deletions
75
matlab/src/cpp/arrow/matlab/io/ipc/proxy/record_batch_writer.cc
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| // Licensed to the Apache Software Foundation (ASF) under one | ||
| // or more contributor license agreements. See the NOTICE file | ||
| // distributed with this work for additional information | ||
| // regarding copyright ownership. The ASF licenses this file | ||
| // to you under the Apache License, Version 2.0 (the | ||
| // "License"); you may not use this file except in compliance | ||
| // with the License. You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, | ||
| // software distributed under the License is distributed on an | ||
| // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| // KIND, either express or implied. See the License for the | ||
| // specific language governing permissions and limitations | ||
| // under the License. | ||
|
|
||
| #include "arrow/matlab/io/ipc/proxy/record_batch_writer.h" | ||
| #include "arrow/io/file.h" | ||
| #include "arrow/matlab/error/error.h" | ||
| #include "arrow/matlab/tabular/proxy/record_batch.h" | ||
| #include "arrow/matlab/tabular/proxy/schema.h" | ||
| #include "arrow/matlab/tabular/proxy/table.h" | ||
|
|
||
| #include "libmexclass/proxy/ProxyManager.h" | ||
|
|
||
| namespace arrow::matlab::io::ipc::proxy { | ||
|
|
||
| RecordBatchWriter::RecordBatchWriter( | ||
| const std::shared_ptr<arrow::ipc::RecordBatchWriter> writer) | ||
| : writer{std::move(writer)} { | ||
| REGISTER_METHOD(RecordBatchWriter, close); | ||
| REGISTER_METHOD(RecordBatchWriter, writeRecordBatch); | ||
| REGISTER_METHOD(RecordBatchWriter, writeTable); | ||
| } | ||
|
|
||
| void RecordBatchWriter::writeRecordBatch(libmexclass::proxy::method::Context& context) { | ||
| namespace mda = ::matlab::data; | ||
| using RecordBatchProxy = ::arrow::matlab::tabular::proxy::RecordBatch; | ||
|
|
||
| mda::StructArray opts = context.inputs[0]; | ||
| const mda::TypedArray<uint64_t> record_batch_proxy_id_mda = | ||
| opts[0]["RecordBatchProxyID"]; | ||
| const uint64_t record_batch_proxy_id = record_batch_proxy_id_mda[0]; | ||
|
|
||
| auto proxy = libmexclass::proxy::ProxyManager::getProxy(record_batch_proxy_id); | ||
| auto record_batch_proxy = std::static_pointer_cast<RecordBatchProxy>(proxy); | ||
| auto record_batch = record_batch_proxy->unwrap(); | ||
|
|
||
| MATLAB_ERROR_IF_NOT_OK_WITH_CONTEXT(writer->WriteRecordBatch(*record_batch), context, | ||
| error::IPC_RECORD_BATCH_WRITE_FAILED); | ||
| } | ||
|
|
||
| void RecordBatchWriter::writeTable(libmexclass::proxy::method::Context& context) { | ||
| namespace mda = ::matlab::data; | ||
| using TableProxy = ::arrow::matlab::tabular::proxy::Table; | ||
|
|
||
| mda::StructArray opts = context.inputs[0]; | ||
| const mda::TypedArray<uint64_t> table_proxy_id_mda = opts[0]["TableProxyID"]; | ||
| const uint64_t table_proxy_id = table_proxy_id_mda[0]; | ||
|
|
||
| auto proxy = libmexclass::proxy::ProxyManager::getProxy(table_proxy_id); | ||
| auto table_proxy = std::static_pointer_cast<TableProxy>(proxy); | ||
| auto table = table_proxy->unwrap(); | ||
|
|
||
| MATLAB_ERROR_IF_NOT_OK_WITH_CONTEXT(writer->WriteTable(*table), context, | ||
| error::IPC_RECORD_BATCH_WRITE_FAILED); | ||
| } | ||
|
|
||
| void RecordBatchWriter::close(libmexclass::proxy::method::Context& context) { | ||
| MATLAB_ERROR_IF_NOT_OK_WITH_CONTEXT(writer->Close(), context, | ||
| error::IPC_RECORD_BATCH_WRITE_CLOSE_FAILED); | ||
| } | ||
|
|
||
| } // namespace arrow::matlab::io::ipc::proxy |
41 changes: 41 additions & 0 deletions
41
matlab/src/cpp/arrow/matlab/io/ipc/proxy/record_batch_writer.h
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| // Licensed to the Apache Software Foundation (ASF) under one | ||
| // or more contributor license agreements. See the NOTICE file | ||
| // distributed with this work for additional information | ||
| // regarding copyright ownership. The ASF licenses this file | ||
| // to you under the Apache License, Version 2.0 (the | ||
| // "License"); you may not use this file except in compliance | ||
| // with the License. You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, | ||
| // software distributed under the License is distributed on an | ||
| // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| // KIND, either express or implied. See the License for the | ||
| // specific language governing permissions and limitations | ||
| // under the License. | ||
|
|
||
| #pragma once | ||
|
|
||
| #include "arrow/ipc/writer.h" | ||
| #include "libmexclass/proxy/Proxy.h" | ||
|
|
||
| namespace arrow::matlab::io::ipc::proxy { | ||
|
|
||
| class RecordBatchWriter : public libmexclass::proxy::Proxy { | ||
| public: | ||
| RecordBatchWriter(std::shared_ptr<arrow::ipc::RecordBatchWriter> writer); | ||
|
|
||
| virtual ~RecordBatchWriter() = default; | ||
|
|
||
| protected: | ||
| std::shared_ptr<arrow::ipc::RecordBatchWriter> writer; | ||
|
|
||
| void writeRecordBatch(libmexclass::proxy::method::Context& context); | ||
|
|
||
| void writeTable(libmexclass::proxy::method::Context& context); | ||
|
|
||
| void close(libmexclass::proxy::method::Context& context); | ||
| }; | ||
|
|
||
| } // namespace arrow::matlab::io::ipc::proxy |
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
Oops, something went wrong.