emkornfield commented on a change in pull request #10658:
URL: https://github.com/apache/arrow/pull/10658#discussion_r664719015
##########
File path: docs/source/cpp/csv.rst
##########
@@ -69,6 +69,44 @@ A CSV file is read from a :class:`~arrow::io::InputStream`.
std::shared_ptr<arrow::Table> table = *maybe_table;
}
+A CSV file is written to a :class:`~arrow::io::OutputStream`.
+
+.. code-block:: cpp
+
+ #include <arrow/csv/api.h>
+ {
+ // Oneshot write
+ // ...
+ std::shared_ptr<arrow::io::OutputStream> output = ...;
+ auto write_options = arrow::csv::WriteOptions::Defaults();
+ if (WriteCSV(table, options, output.get()).ok()) {
+ // Handle writer error...
+ }
+ }
+ {
+ // Write incrementally
+ // ...
+ std::shared_ptr<arrow::io::OutputStream> output = ...;
+ auto write_options = arrow::csv::WriteOptions::Defaults();
+ auto maybe_writer = arrow::csv::MakeCSVWriter(output, schema, options);
+ if (!maybe_writer.ok()) {
+ // Handle writer instantiation error...
+ }
+ std::shared_ptr<arrow::ipc::RecordBatchWriter> writer = *maybe_writer;
+
+ // Write batches...
+ if (!writer->WriteRecordBatch(*batch).ok()) {
Review comment:
I don't feel too strongly especially if this is consistent with other
docs, but I think using status macros might make sense here.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
