You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@arrow.apache.org by uw...@apache.org on 2017/11/04 10:37:33 UTC
[15/51] [partial] arrow-site git commit: API doc update
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/35e0e750/docs/cpp/classarrow_1_1ipc_1_1_record_batch_file_reader.html
----------------------------------------------------------------------
diff --git a/docs/cpp/classarrow_1_1ipc_1_1_record_batch_file_reader.html b/docs/cpp/classarrow_1_1ipc_1_1_record_batch_file_reader.html
index 41b0867..0e8339a 100644
--- a/docs/cpp/classarrow_1_1ipc_1_1_record_batch_file_reader.html
+++ b/docs/cpp/classarrow_1_1ipc_1_1_record_batch_file_reader.html
@@ -75,23 +75,23 @@ $(function() {
<p>Reads the record batch file format.
<a href="classarrow_1_1ipc_1_1_record_batch_file_reader.html#details">More...</a></p>
-<p><code>#include <<a class="el" href="reader_8h_source.html">reader.h</a>></code></p>
+<p><code>#include <<a class="el" href="reader_8h_source.html">arrow/ipc/reader.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a3300bc02cf6b8a98cddba3fee224809b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_file_reader.html#a3300bc02cf6b8a98cddba3fee224809b">~RecordBatchFileReader</a> ()</td></tr>
<tr class="separator:a3300bc02cf6b8a98cddba3fee224809b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a849221c7de7406083d59c3c921d418d0"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classarrow_1_1_schema.html">Schema</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_file_reader.html#a849221c7de7406083d59c3c921d418d0">schema</a> () const</td></tr>
-<tr class="memdesc:a849221c7de7406083d59c3c921d418d0"><td class="mdescLeft"> </td><td class="mdescRight">The schema includes any dictionaries. <a href="#a849221c7de7406083d59c3c921d418d0">More...</a><br /></td></tr>
+<tr class="memdesc:a849221c7de7406083d59c3c921d418d0"><td class="mdescLeft"> </td><td class="mdescRight">The schema read from the file. <a href="#a849221c7de7406083d59c3c921d418d0">More...</a><br /></td></tr>
<tr class="separator:a849221c7de7406083d59c3c921d418d0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a668c56904fe904316fa595b8b481c17d"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_file_reader.html#a668c56904fe904316fa595b8b481c17d">num_record_batches</a> () const</td></tr>
-<tr class="memdesc:a668c56904fe904316fa595b8b481c17d"><td class="mdescLeft"> </td><td class="mdescRight">Returns number of record batches in the file. <a href="#a668c56904fe904316fa595b8b481c17d">More...</a><br /></td></tr>
+<tr class="memdesc:a668c56904fe904316fa595b8b481c17d"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of record batches in the file. <a href="#a668c56904fe904316fa595b8b481c17d">More...</a><br /></td></tr>
<tr class="separator:a668c56904fe904316fa595b8b481c17d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8599c8188617963a7b84fc874e5976e8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacearrow_1_1ipc.html#aa5d7ec68a8c707271bab98af9bc0ac77">MetadataVersion</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_file_reader.html#a8599c8188617963a7b84fc874e5976e8">version</a> () const</td></tr>
-<tr class="memdesc:a8599c8188617963a7b84fc874e5976e8"><td class="mdescLeft"> </td><td class="mdescRight">Returns MetadataVersion in the file metadata. <a href="#a8599c8188617963a7b84fc874e5976e8">More...</a><br /></td></tr>
+<tr class="memdesc:a8599c8188617963a7b84fc874e5976e8"><td class="mdescLeft"> </td><td class="mdescRight">Return the metadata version from the file metadata. <a href="#a8599c8188617963a7b84fc874e5976e8">More...</a><br /></td></tr>
<tr class="separator:a8599c8188617963a7b84fc874e5976e8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1965dcb875eaded071abe97db20feb4e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_file_reader.html#a1965dcb875eaded071abe97db20feb4e">ReadRecordBatch</a> (int i, std::shared_ptr< <a class="el" href="classarrow_1_1_record_batch.html">RecordBatch</a> > *batch)</td></tr>
-<tr class="memdesc:a1965dcb875eaded071abe97db20feb4e"><td class="mdescLeft"> </td><td class="mdescRight">Read a record batch from the file. <a href="#a1965dcb875eaded071abe97db20feb4e">More...</a><br /></td></tr>
+<tr class="memdesc:a1965dcb875eaded071abe97db20feb4e"><td class="mdescLeft"> </td><td class="mdescRight">Read a particular record batch from the file. <a href="#a1965dcb875eaded071abe97db20feb4e">More...</a><br /></td></tr>
<tr class="separator:a1965dcb875eaded071abe97db20feb4e"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
@@ -145,7 +145,7 @@ Static Public Member Functions</h2></td></tr>
</table>
</div><div class="memdoc">
-<p>Returns number of record batches in the file. </p>
+<p>Returns the number of record batches in the file. </p>
</div>
</div>
@@ -184,6 +184,7 @@ Static Public Member Functions</h2></td></tr>
</div><div class="memdoc">
<p>Open a <a class="el" href="classarrow_1_1ipc_1_1_record_batch_file_reader.html" title="Reads the record batch file format. ">RecordBatchFileReader</a>. </p>
+<p>Open a file-like object that is assumed to be self-contained; i.e., the end of the file interface is the end of the Arrow file. Note that there can be any amount of data preceding the Arrow-formatted data, because we need only locate the end of the Arrow file stream to discover the metadata and then proceed to read the data into memory. </p>
</div>
</div>
@@ -231,11 +232,13 @@ Static Public Member Functions</h2></td></tr>
<p>The metadata must have been written with memory offsets relative to the start of the containing file</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
- <tr><td class="paramname">file</td><td>the data source </td></tr>
- <tr><td class="paramname">footer_offset</td><td>the position of the end of the Arrow "file" </td></tr>
+ <tr><td class="paramdir">[in]</td><td class="paramname">file</td><td>the data source </td></tr>
+ <tr><td class="paramdir">[in]</td><td class="paramname">footer_offset</td><td>the position of the end of the Arrow file </td></tr>
+ <tr><td class="paramdir">[out]</td><td class="paramname">reader</td><td>the returned reader </td></tr>
</table>
</dd>
</dl>
+<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classarrow_1_1_status.html">Status</a> </dd></dl>
</div>
</div>
@@ -274,6 +277,14 @@ Static Public Member Functions</h2></td></tr>
</div><div class="memdoc">
<p>Version of Open that retains ownership of file. </p>
+<dl class="params"><dt>Parameters</dt><dd>
+ <table class="params">
+ <tr><td class="paramdir">[in]</td><td class="paramname">file</td><td>the data source </td></tr>
+ <tr><td class="paramdir">[out]</td><td class="paramname">reader</td><td>the returned reader </td></tr>
+ </table>
+ </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classarrow_1_1_status.html">Status</a> </dd></dl>
</div>
</div>
@@ -318,6 +329,15 @@ Static Public Member Functions</h2></td></tr>
</div><div class="memdoc">
<p>Version of Open that retains ownership of file. </p>
+<dl class="params"><dt>Parameters</dt><dd>
+ <table class="params">
+ <tr><td class="paramdir">[in]</td><td class="paramname">file</td><td>the data source </td></tr>
+ <tr><td class="paramdir">[in]</td><td class="paramname">footer_offset</td><td>the position of the end of the Arrow file </td></tr>
+ <tr><td class="paramdir">[out]</td><td class="paramname">reader</td><td>the returned reader </td></tr>
+ </table>
+ </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classarrow_1_1_status.html">Status</a> </dd></dl>
</div>
</div>
@@ -347,7 +367,7 @@ Static Public Member Functions</h2></td></tr>
</table>
</div><div class="memdoc">
-<p>Read a record batch from the file. </p>
+<p>Read a particular record batch from the file. </p>
<p>Does not copy memory if the input source supports zero-copy.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
@@ -375,7 +395,7 @@ Static Public Member Functions</h2></td></tr>
</table>
</div><div class="memdoc">
-<p>The schema includes any dictionaries. </p>
+<p>The schema read from the file. </p>
</div>
</div>
@@ -394,7 +414,7 @@ Static Public Member Functions</h2></td></tr>
</table>
</div><div class="memdoc">
-<p>Returns MetadataVersion in the file metadata. </p>
+<p>Return the metadata version from the file metadata. </p>
</div>
</div>
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/35e0e750/docs/cpp/classarrow_1_1ipc_1_1_record_batch_file_writer-members.html
----------------------------------------------------------------------
diff --git a/docs/cpp/classarrow_1_1ipc_1_1_record_batch_file_writer-members.html b/docs/cpp/classarrow_1_1ipc_1_1_record_batch_file_writer-members.html
index faf5255..35e1d83 100644
--- a/docs/cpp/classarrow_1_1ipc_1_1_record_batch_file_writer-members.html
+++ b/docs/cpp/classarrow_1_1ipc_1_1_record_batch_file_writer-members.html
@@ -72,8 +72,6 @@ $(function() {
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_file_writer.html#a94dfca0d761fefeeeb610e1a6f4854d6">Close</a>() override</td><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_file_writer.html">arrow::ipc::RecordBatchFileWriter</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_file_writer.html#a863b8c0902c9f0b78c03a1bf6ca82424">Open</a>(io::OutputStream *sink, const std::shared_ptr< Schema > &schema, std::shared_ptr< RecordBatchWriter > *out)</td><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_file_writer.html">arrow::ipc::RecordBatchFileWriter</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
- <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_file_writer.html#ae6e7e994ce53be616b14e3f4462c0cb2">Open</a>(io::OutputStream *sink, const std::shared_ptr< Schema > &schema, std::shared_ptr< RecordBatchFileWriter > *out)</td><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_file_writer.html">arrow::ipc::RecordBatchFileWriter</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
- <tr><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html#aff8b31c332cc9bd7ba83275fdff081ea">arrow::ipc::RecordBatchStreamWriter::Open</a>(io::OutputStream *sink, const std::shared_ptr< Schema > &schema, std::shared_ptr< RecordBatchStreamWriter > *out)</td><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html">arrow::ipc::RecordBatchStreamWriter</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html#a88e6690fbf4ee337e65577952a2f03fc">RecordBatchStreamWriter</a>()</td><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html">arrow::ipc::RecordBatchStreamWriter</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html#a38780b171958b6ac66d851990c37eed2">RecordBatchStreamWriterImpl</a></td><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html">arrow::ipc::RecordBatchStreamWriter</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html#ac7c5f65e9186a192c254e2b74a36e41e">set_memory_pool</a>(MemoryPool *pool) override</td><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html">arrow::ipc::RecordBatchStreamWriter</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/35e0e750/docs/cpp/classarrow_1_1ipc_1_1_record_batch_file_writer.html
----------------------------------------------------------------------
diff --git a/docs/cpp/classarrow_1_1ipc_1_1_record_batch_file_writer.html b/docs/cpp/classarrow_1_1ipc_1_1_record_batch_file_writer.html
index 926bd04..0571932 100644
--- a/docs/cpp/classarrow_1_1ipc_1_1_record_batch_file_writer.html
+++ b/docs/cpp/classarrow_1_1ipc_1_1_record_batch_file_writer.html
@@ -75,7 +75,7 @@ $(function() {
<p>Creates the Arrow record batch file format.
<a href="classarrow_1_1ipc_1_1_record_batch_file_writer.html#details">More...</a></p>
-<p><code>#include <<a class="el" href="writer_8h_source.html">writer.h</a>></code></p>
+<p><code>#include <<a class="el" href="writer_8h_source.html">arrow/ipc/writer.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for arrow::ipc::RecordBatchFileWriter:</div>
<div class="dyncontent">
@@ -92,10 +92,10 @@ Public Member Functions</h2></td></tr>
<tr class="memitem:acdcab22c935251c3ec14fb0472264c52"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_file_writer.html#acdcab22c935251c3ec14fb0472264c52">~RecordBatchFileWriter</a> ()</td></tr>
<tr class="separator:acdcab22c935251c3ec14fb0472264c52"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a53c4797daa7d7afb8221c1c2807e149b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_file_writer.html#a53c4797daa7d7afb8221c1c2807e149b">WriteRecordBatch</a> (const <a class="el" href="classarrow_1_1_record_batch.html">RecordBatch</a> &batch, bool allow_64bit=false) override</td></tr>
-<tr class="memdesc:a53c4797daa7d7afb8221c1c2807e149b"><td class="mdescLeft"> </td><td class="mdescRight">Write a record batch to the stream. <a href="#a53c4797daa7d7afb8221c1c2807e149b">More...</a><br /></td></tr>
+<tr class="memdesc:a53c4797daa7d7afb8221c1c2807e149b"><td class="mdescLeft"> </td><td class="mdescRight">Write a record batch to the file. <a href="#a53c4797daa7d7afb8221c1c2807e149b">More...</a><br /></td></tr>
<tr class="separator:a53c4797daa7d7afb8221c1c2807e149b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a94dfca0d761fefeeeb610e1a6f4854d6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_file_writer.html#a94dfca0d761fefeeeb610e1a6f4854d6">Close</a> () override</td></tr>
-<tr class="memdesc:a94dfca0d761fefeeeb610e1a6f4854d6"><td class="mdescLeft"> </td><td class="mdescRight">Perform any logic necessary to finish the stream. <a href="#a94dfca0d761fefeeeb610e1a6f4854d6">More...</a><br /></td></tr>
+<tr class="memdesc:a94dfca0d761fefeeeb610e1a6f4854d6"><td class="mdescLeft"> </td><td class="mdescRight">Close the file stream by writing the file footer and magic number. <a href="#a94dfca0d761fefeeeb610e1a6f4854d6">More...</a><br /></td></tr>
<tr class="separator:a94dfca0d761fefeeeb610e1a6f4854d6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classarrow_1_1ipc_1_1_record_batch_stream_writer"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarrow_1_1ipc_1_1_record_batch_stream_writer')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html">arrow::ipc::RecordBatchStreamWriter</a></td></tr>
<tr class="memitem:af84936f0d36f7f3461161d254448f9c4 inherit pub_methods_classarrow_1_1ipc_1_1_record_batch_stream_writer"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html#af84936f0d36f7f3461161d254448f9c4">~RecordBatchStreamWriter</a> ()</td></tr>
@@ -112,17 +112,13 @@ Public Member Functions</h2></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
-<tr class="memitem:a863b8c0902c9f0b78c03a1bf6ca82424"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_file_writer.html#a863b8c0902c9f0b78c03a1bf6ca82424">Open</a> (<a class="el" href="classarrow_1_1io_1_1_output_stream.html">io::OutputStream</a> *sink, const std::shared_ptr< <a class="el" href="classarrow_1_1_schema.html">Schema</a> > &<a class="el" href="namespacearrow.html#ae1692c648f5447a7f95ddbe2c4e9a5fc">schema</a>, std::shared_ptr< <a class="el" href="classarrow_1_1ipc_1_1_record_batch_writer.html">RecordBatchWriter</a> > *out)</td></tr>
+<tr class="memitem:a863b8c0902c9f0b78c03a1bf6ca82424"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_file_writer.html#a863b8c0902c9f0b78c03a1bf6ca82424">Open</a> (<a class="el" href="classarrow_1_1io_1_1_output_stream.html">io::OutputStream</a> *sink, const std::shared_ptr< <a class="el" href="classarrow_1_1_schema.html">Schema</a> > &<a class="el" href="namespacearrow.html#a97ac72c2a07228577c1d38b7747941a9">schema</a>, std::shared_ptr< <a class="el" href="classarrow_1_1ipc_1_1_record_batch_writer.html">RecordBatchWriter</a> > *out)</td></tr>
<tr class="memdesc:a863b8c0902c9f0b78c03a1bf6ca82424"><td class="mdescLeft"> </td><td class="mdescRight">Create a new writer from stream sink and schema. <a href="#a863b8c0902c9f0b78c03a1bf6ca82424">More...</a><br /></td></tr>
<tr class="separator:a863b8c0902c9f0b78c03a1bf6ca82424"><td class="memSeparator" colspan="2"> </td></tr>
-<tr class="memitem:ae6e7e994ce53be616b14e3f4462c0cb2"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_file_writer.html#ae6e7e994ce53be616b14e3f4462c0cb2">Open</a> (<a class="el" href="classarrow_1_1io_1_1_output_stream.html">io::OutputStream</a> *sink, const std::shared_ptr< <a class="el" href="classarrow_1_1_schema.html">Schema</a> > &<a class="el" href="namespacearrow.html#ae1692c648f5447a7f95ddbe2c4e9a5fc">schema</a>, std::shared_ptr< <a class="el" href="classarrow_1_1ipc_1_1_record_batch_file_writer.html">RecordBatchFileWriter</a> > *out)</td></tr>
-<tr class="separator:ae6e7e994ce53be616b14e3f4462c0cb2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_static_methods_classarrow_1_1ipc_1_1_record_batch_stream_writer"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_classarrow_1_1ipc_1_1_record_batch_stream_writer')"><img src="closed.png" alt="-"/> Static Public Member Functions inherited from <a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html">arrow::ipc::RecordBatchStreamWriter</a></td></tr>
-<tr class="memitem:afa77ce400799a9e9820825b38722b8de inherit pub_static_methods_classarrow_1_1ipc_1_1_record_batch_stream_writer"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html#afa77ce400799a9e9820825b38722b8de">Open</a> (<a class="el" href="classarrow_1_1io_1_1_output_stream.html">io::OutputStream</a> *sink, const std::shared_ptr< <a class="el" href="classarrow_1_1_schema.html">Schema</a> > &<a class="el" href="namespacearrow.html#ae1692c648f5447a7f95ddbe2c4e9a5fc">schema</a>, std::shared_ptr< <a class="el" href="classarrow_1_1ipc_1_1_record_batch_writer.html">RecordBatchWriter</a> > *out)</td></tr>
+<tr class="memitem:afa77ce400799a9e9820825b38722b8de inherit pub_static_methods_classarrow_1_1ipc_1_1_record_batch_stream_writer"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html#afa77ce400799a9e9820825b38722b8de">Open</a> (<a class="el" href="classarrow_1_1io_1_1_output_stream.html">io::OutputStream</a> *sink, const std::shared_ptr< <a class="el" href="classarrow_1_1_schema.html">Schema</a> > &<a class="el" href="namespacearrow.html#a97ac72c2a07228577c1d38b7747941a9">schema</a>, std::shared_ptr< <a class="el" href="classarrow_1_1ipc_1_1_record_batch_writer.html">RecordBatchWriter</a> > *out)</td></tr>
<tr class="memdesc:afa77ce400799a9e9820825b38722b8de inherit pub_static_methods_classarrow_1_1ipc_1_1_record_batch_stream_writer"><td class="mdescLeft"> </td><td class="mdescRight">Create a new writer from stream sink and schema. <a href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html#afa77ce400799a9e9820825b38722b8de">More...</a><br /></td></tr>
<tr class="separator:afa77ce400799a9e9820825b38722b8de inherit pub_static_methods_classarrow_1_1ipc_1_1_record_batch_stream_writer"><td class="memSeparator" colspan="2"> </td></tr>
-<tr class="memitem:aff8b31c332cc9bd7ba83275fdff081ea inherit pub_static_methods_classarrow_1_1ipc_1_1_record_batch_stream_writer"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html#aff8b31c332cc9bd7ba83275fdff081ea">Open</a> (<a class="el" href="classarrow_1_1io_1_1_output_stream.html">io::OutputStream</a> *sink, const std::shared_ptr< <a class="el" href="classarrow_1_1_schema.html">Schema</a> > &<a class="el" href="namespacearrow.html#ae1692c648f5447a7f95ddbe2c4e9a5fc">schema</a>, std::shared_ptr< <a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html">RecordBatchStreamWriter</a> > *out)</td></tr>
-<tr class="separator:aff8b31c332cc9bd7ba83275fdff081ea inherit pub_static_methods_classarrow_1_1ipc_1_1_record_batch_stream_writer"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
@@ -188,7 +184,7 @@ Additional Inherited Members</h2></td></tr>
</table>
</div><div class="memdoc">
-<p>Perform any logic necessary to finish the stream. </p>
+<p>Close the file stream by writing the file footer and magic number. </p>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classarrow_1_1_status.html">Status</a> </dd></dl>
<p>Reimplemented from <a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html#a2619ef5f3dccdb9e606a944c406ecad6">arrow::ipc::RecordBatchStreamWriter</a>.</p>
@@ -196,7 +192,7 @@ Additional Inherited Members</h2></td></tr>
</div>
</div>
<a id="a863b8c0902c9f0b78c03a1bf6ca82424"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a863b8c0902c9f0b78c03a1bf6ca82424">◆ </a></span>Open() <span class="overload">[1/2]</span></h2>
+<h2 class="memtitle"><span class="permalink"><a href="#a863b8c0902c9f0b78c03a1bf6ca82424">◆ </a></span>Open()</h2>
<div class="memitem">
<div class="memproto">
@@ -248,49 +244,6 @@ Additional Inherited Members</h2></td></tr>
</div>
</div>
-<a id="ae6e7e994ce53be616b14e3f4462c0cb2"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#ae6e7e994ce53be616b14e3f4462c0cb2">◆ </a></span>Open() <span class="overload">[2/2]</span></h2>
-
-<div class="memitem">
-<div class="memproto">
-<table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">static <a class="el" href="classarrow_1_1_status.html">Status</a> arrow::ipc::RecordBatchFileWriter::Open </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="classarrow_1_1io_1_1_output_stream.html">io::OutputStream</a> * </td>
- <td class="paramname"><em>sink</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const std::shared_ptr< <a class="el" href="classarrow_1_1_schema.html">Schema</a> > & </td>
- <td class="paramname"><em>schema</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">std::shared_ptr< <a class="el" href="classarrow_1_1ipc_1_1_record_batch_file_writer.html">RecordBatchFileWriter</a> > * </td>
- <td class="paramname"><em>out</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
-<span class="mlabels"><span class="mlabel">static</span></span> </td>
- </tr>
-</table>
-</div><div class="memdoc">
-<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000015">Deprecated:</a></b></dt><dd>Since 0.7.0 </dd></dl>
-
-</div>
-</div>
<a id="a53c4797daa7d7afb8221c1c2807e149b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a53c4797daa7d7afb8221c1c2807e149b">◆ </a></span>WriteRecordBatch()</h2>
@@ -325,10 +278,11 @@ Additional Inherited Members</h2></td></tr>
</table>
</div><div class="memdoc">
-<p>Write a record batch to the stream. </p>
+<p>Write a record batch to the file. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
- <tr><td class="paramname">allow_64bit</td><td>boolean permitting field lengths exceeding INT32_MAX </td></tr>
+ <tr><td class="paramdir">[in]</td><td class="paramname">batch</td><td>the record batch to write </td></tr>
+ <tr><td class="paramdir">[in]</td><td class="paramname">allow_64bit</td><td>allow array lengths over INT32_MAX - 1 </td></tr>
</table>
</dd>
</dl>
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/35e0e750/docs/cpp/classarrow_1_1ipc_1_1_record_batch_stream_reader-members.html
----------------------------------------------------------------------
diff --git a/docs/cpp/classarrow_1_1ipc_1_1_record_batch_stream_reader-members.html b/docs/cpp/classarrow_1_1ipc_1_1_record_batch_stream_reader-members.html
index 74dc082..f739adc 100644
--- a/docs/cpp/classarrow_1_1ipc_1_1_record_batch_stream_reader-members.html
+++ b/docs/cpp/classarrow_1_1ipc_1_1_record_batch_stream_reader-members.html
@@ -71,15 +71,12 @@ $(function() {
<p>This is the complete list of members for <a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_reader.html">arrow::ipc::RecordBatchStreamReader</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_reader.html#a06160a910260d4590228dcd797fe8031">Open</a>(std::unique_ptr< MessageReader > message_reader, std::shared_ptr< RecordBatchReader > *out)</td><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_reader.html">arrow::ipc::RecordBatchStreamReader</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
- <tr><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_reader.html#a461af1f6b71839280b4d9d4fd81e6b4d">Open</a>(std::unique_ptr< MessageReader > message_reader, std::shared_ptr< RecordBatchStreamReader > *out)</td><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_reader.html">arrow::ipc::RecordBatchStreamReader</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
- <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_reader.html#a42fde4309f948c796e2daa97339819a3">Open</a>(const std::shared_ptr< io::InputStream > &stream, std::shared_ptr< RecordBatchStreamReader > *out)</td><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_reader.html">arrow::ipc::RecordBatchStreamReader</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_reader.html#add9a0fff807a286725be187804e2e0d7">Open</a>(io::InputStream *stream, std::shared_ptr< RecordBatchReader > *out)</td><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_reader.html">arrow::ipc::RecordBatchStreamReader</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_reader.html#ae24d0050f1a9533c8414996e9cf570a5">Open</a>(const std::shared_ptr< io::InputStream > &stream, std::shared_ptr< RecordBatchReader > *out)</td><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_reader.html">arrow::ipc::RecordBatchStreamReader</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_reader.html#ae8a274f899c14b9b8d629e658609b96f">ReadNext</a>(std::shared_ptr< RecordBatch > *batch) override</td><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_reader.html">arrow::ipc::RecordBatchStreamReader</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
- <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_record_batch_reader.html#a8ac4623435d60509ac5a5ec22c98d59b">ReadNextRecordBatch</a>(std::shared_ptr< RecordBatch > *batch)</td><td class="entry"><a class="el" href="classarrow_1_1_record_batch_reader.html">arrow::RecordBatchReader</a></td><td class="entry"></td></tr>
- <tr><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_reader.html#a6955614f73bb4a6a62cbac895648a322">schema</a>() const override</td><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_reader.html">arrow::ipc::RecordBatchStreamReader</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
- <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1_record_batch_reader.html#ad8660ce224397979fbf0da8898e55047">~RecordBatchReader</a>()</td><td class="entry"><a class="el" href="classarrow_1_1_record_batch_reader.html">arrow::RecordBatchReader</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
- <tr><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_reader.html#a0005d2d5363446f1e2e877c9e3b39e52">~RecordBatchStreamReader</a>()</td><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_reader.html">arrow::ipc::RecordBatchStreamReader</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
+ <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_reader.html#a6955614f73bb4a6a62cbac895648a322">schema</a>() const override</td><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_reader.html">arrow::ipc::RecordBatchStreamReader</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
+ <tr><td class="entry"><a class="el" href="classarrow_1_1_record_batch_reader.html#ad8660ce224397979fbf0da8898e55047">~RecordBatchReader</a>()</td><td class="entry"><a class="el" href="classarrow_1_1_record_batch_reader.html">arrow::RecordBatchReader</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
+ <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_reader.html#a0005d2d5363446f1e2e877c9e3b39e52">~RecordBatchStreamReader</a>()</td><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_reader.html">arrow::ipc::RecordBatchStreamReader</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/35e0e750/docs/cpp/classarrow_1_1ipc_1_1_record_batch_stream_reader.html
----------------------------------------------------------------------
diff --git a/docs/cpp/classarrow_1_1ipc_1_1_record_batch_stream_reader.html b/docs/cpp/classarrow_1_1ipc_1_1_record_batch_stream_reader.html
index a978cba..e3d0167 100644
--- a/docs/cpp/classarrow_1_1ipc_1_1_record_batch_stream_reader.html
+++ b/docs/cpp/classarrow_1_1ipc_1_1_record_batch_stream_reader.html
@@ -75,7 +75,7 @@ $(function() {
<p>Synchronous batch stream reader that reads from <a class="el" href="classarrow_1_1io_1_1_input_stream.html">io::InputStream</a>.
<a href="classarrow_1_1ipc_1_1_record_batch_stream_reader.html#details">More...</a></p>
-<p><code>#include <<a class="el" href="reader_8h_source.html">reader.h</a>></code></p>
+<p><code>#include <<a class="el" href="reader_8h_source.html">arrow/ipc/reader.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for arrow::ipc::RecordBatchStreamReader:</div>
<div class="dyncontent">
@@ -91,6 +91,7 @@ Public Member Functions</h2></td></tr>
<tr class="memitem:a0005d2d5363446f1e2e877c9e3b39e52"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_reader.html#a0005d2d5363446f1e2e877c9e3b39e52">~RecordBatchStreamReader</a> ()</td></tr>
<tr class="separator:a0005d2d5363446f1e2e877c9e3b39e52"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6955614f73bb4a6a62cbac895648a322"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classarrow_1_1_schema.html">Schema</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_reader.html#a6955614f73bb4a6a62cbac895648a322">schema</a> () const override</td></tr>
+<tr class="memdesc:a6955614f73bb4a6a62cbac895648a322"><td class="mdescLeft"> </td><td class="mdescRight">Returns the schema read from the stream. <a href="#a6955614f73bb4a6a62cbac895648a322">More...</a><br /></td></tr>
<tr class="separator:a6955614f73bb4a6a62cbac895648a322"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae8a274f899c14b9b8d629e658609b96f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_reader.html#ae8a274f899c14b9b8d629e658609b96f">ReadNext</a> (std::shared_ptr< <a class="el" href="classarrow_1_1_record_batch.html">RecordBatch</a> > *batch) override</td></tr>
<tr class="memdesc:ae8a274f899c14b9b8d629e658609b96f"><td class="mdescLeft"> </td><td class="mdescRight">Read the next record batch in the stream. <a href="#ae8a274f899c14b9b8d629e658609b96f">More...</a><br /></td></tr>
@@ -98,27 +99,22 @@ Public Member Functions</h2></td></tr>
<tr class="inherit_header pub_methods_classarrow_1_1_record_batch_reader"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarrow_1_1_record_batch_reader')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classarrow_1_1_record_batch_reader.html">arrow::RecordBatchReader</a></td></tr>
<tr class="memitem:ad8660ce224397979fbf0da8898e55047 inherit pub_methods_classarrow_1_1_record_batch_reader"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_record_batch_reader.html#ad8660ce224397979fbf0da8898e55047">~RecordBatchReader</a> ()</td></tr>
<tr class="separator:ad8660ce224397979fbf0da8898e55047 inherit pub_methods_classarrow_1_1_record_batch_reader"><td class="memSeparator" colspan="2"> </td></tr>
-<tr class="memitem:a8ac4623435d60509ac5a5ec22c98d59b inherit pub_methods_classarrow_1_1_record_batch_reader"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1_record_batch_reader.html#a8ac4623435d60509ac5a5ec22c98d59b">ReadNextRecordBatch</a> (std::shared_ptr< <a class="el" href="classarrow_1_1_record_batch.html">RecordBatch</a> > *batch)</td></tr>
-<tr class="separator:a8ac4623435d60509ac5a5ec22c98d59b inherit pub_methods_classarrow_1_1_record_batch_reader"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a06160a910260d4590228dcd797fe8031"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_reader.html#a06160a910260d4590228dcd797fe8031">Open</a> (std::unique_ptr< <a class="el" href="classarrow_1_1ipc_1_1_message_reader.html">MessageReader</a> > message_reader, std::shared_ptr< <a class="el" href="namespacearrow_1_1ipc.html#a6eae3918b2e6c0c4e1f56e083187a339">RecordBatchReader</a> > *out)</td></tr>
<tr class="memdesc:a06160a910260d4590228dcd797fe8031"><td class="mdescLeft"> </td><td class="mdescRight">Create batch reader from generic <a class="el" href="classarrow_1_1ipc_1_1_message_reader.html" title="Abstract interface for a sequence of messages. ">MessageReader</a>. <a href="#a06160a910260d4590228dcd797fe8031">More...</a><br /></td></tr>
<tr class="separator:a06160a910260d4590228dcd797fe8031"><td class="memSeparator" colspan="2"> </td></tr>
-<tr class="memitem:a461af1f6b71839280b4d9d4fd81e6b4d"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_reader.html#a461af1f6b71839280b4d9d4fd81e6b4d">Open</a> (std::unique_ptr< <a class="el" href="classarrow_1_1ipc_1_1_message_reader.html">MessageReader</a> > message_reader, std::shared_ptr< <a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_reader.html">RecordBatchStreamReader</a> > *out)</td></tr>
-<tr class="separator:a461af1f6b71839280b4d9d4fd81e6b4d"><td class="memSeparator" colspan="2"> </td></tr>
-<tr class="memitem:a42fde4309f948c796e2daa97339819a3"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_reader.html#a42fde4309f948c796e2daa97339819a3">Open</a> (const std::shared_ptr< <a class="el" href="classarrow_1_1io_1_1_input_stream.html">io::InputStream</a> > &stream, std::shared_ptr< <a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_reader.html">RecordBatchStreamReader</a> > *out)</td></tr>
-<tr class="separator:a42fde4309f948c796e2daa97339819a3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:add9a0fff807a286725be187804e2e0d7"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_reader.html#add9a0fff807a286725be187804e2e0d7">Open</a> (<a class="el" href="classarrow_1_1io_1_1_input_stream.html">io::InputStream</a> *stream, std::shared_ptr< <a class="el" href="namespacearrow_1_1ipc.html#a6eae3918b2e6c0c4e1f56e083187a339">RecordBatchReader</a> > *out)</td></tr>
<tr class="memdesc:add9a0fff807a286725be187804e2e0d7"><td class="mdescLeft"> </td><td class="mdescRight">Record batch stream reader from InputStream. <a href="#add9a0fff807a286725be187804e2e0d7">More...</a><br /></td></tr>
<tr class="separator:add9a0fff807a286725be187804e2e0d7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae24d0050f1a9533c8414996e9cf570a5"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_reader.html#ae24d0050f1a9533c8414996e9cf570a5">Open</a> (const std::shared_ptr< <a class="el" href="classarrow_1_1io_1_1_input_stream.html">io::InputStream</a> > &stream, std::shared_ptr< <a class="el" href="namespacearrow_1_1ipc.html#a6eae3918b2e6c0c4e1f56e083187a339">RecordBatchReader</a> > *out)</td></tr>
-<tr class="memdesc:ae24d0050f1a9533c8414996e9cf570a5"><td class="mdescLeft"> </td><td class="mdescRight">Version of Open that retains ownership of stream. <a href="#ae24d0050f1a9533c8414996e9cf570a5">More...</a><br /></td></tr>
+<tr class="memdesc:ae24d0050f1a9533c8414996e9cf570a5"><td class="mdescLeft"> </td><td class="mdescRight">Open stream and retain ownership of stream object. <a href="#ae24d0050f1a9533c8414996e9cf570a5">More...</a><br /></td></tr>
<tr class="separator:ae24d0050f1a9533c8414996e9cf570a5"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Synchronous batch stream reader that reads from <a class="el" href="classarrow_1_1io_1_1_input_stream.html">io::InputStream</a>. </p>
+<p>This class reads the schema (plus any dictionaries) as the first messages in the stream, followed by record batches. For more granular zero-copy reads see the ReadRecordBatch functions </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a0005d2d5363446f1e2e877c9e3b39e52"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0005d2d5363446f1e2e877c9e3b39e52">◆ </a></span>~RecordBatchStreamReader()</h2>
@@ -147,7 +143,7 @@ Static Public Member Functions</h2></td></tr>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a06160a910260d4590228dcd797fe8031"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a06160a910260d4590228dcd797fe8031">◆ </a></span>Open() <span class="overload">[1/5]</span></h2>
+<h2 class="memtitle"><span class="permalink"><a href="#a06160a910260d4590228dcd797fe8031">◆ </a></span>Open() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
@@ -192,82 +188,8 @@ Static Public Member Functions</h2></td></tr>
</div>
</div>
-<a id="a461af1f6b71839280b4d9d4fd81e6b4d"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a461af1f6b71839280b4d9d4fd81e6b4d">◆ </a></span>Open() <span class="overload">[2/5]</span></h2>
-
-<div class="memitem">
-<div class="memproto">
-<table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">static <a class="el" href="classarrow_1_1_status.html">Status</a> arrow::ipc::RecordBatchStreamReader::Open </td>
- <td>(</td>
- <td class="paramtype">std::unique_ptr< <a class="el" href="classarrow_1_1ipc_1_1_message_reader.html">MessageReader</a> > </td>
- <td class="paramname"><em>message_reader</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">std::shared_ptr< <a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_reader.html">RecordBatchStreamReader</a> > * </td>
- <td class="paramname"><em>out</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
-<span class="mlabels"><span class="mlabel">static</span></span> </td>
- </tr>
-</table>
-</div><div class="memdoc">
-<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000011">Deprecated:</a></b></dt><dd>Since 0.7.0 </dd></dl>
-
-</div>
-</div>
-<a id="a42fde4309f948c796e2daa97339819a3"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a42fde4309f948c796e2daa97339819a3">◆ </a></span>Open() <span class="overload">[3/5]</span></h2>
-
-<div class="memitem">
-<div class="memproto">
-<table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">static <a class="el" href="classarrow_1_1_status.html">Status</a> arrow::ipc::RecordBatchStreamReader::Open </td>
- <td>(</td>
- <td class="paramtype">const std::shared_ptr< <a class="el" href="classarrow_1_1io_1_1_input_stream.html">io::InputStream</a> > & </td>
- <td class="paramname"><em>stream</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">std::shared_ptr< <a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_reader.html">RecordBatchStreamReader</a> > * </td>
- <td class="paramname"><em>out</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
-<span class="mlabels"><span class="mlabel">static</span></span> </td>
- </tr>
-</table>
-</div><div class="memdoc">
-<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000012">Deprecated:</a></b></dt><dd>Since 0.7.0 </dd></dl>
-
-</div>
-</div>
<a id="add9a0fff807a286725be187804e2e0d7"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#add9a0fff807a286725be187804e2e0d7">◆ </a></span>Open() <span class="overload">[4/5]</span></h2>
+<h2 class="memtitle"><span class="permalink"><a href="#add9a0fff807a286725be187804e2e0d7">◆ </a></span>Open() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
@@ -313,7 +235,7 @@ Static Public Member Functions</h2></td></tr>
</div>
</div>
<a id="ae24d0050f1a9533c8414996e9cf570a5"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#ae24d0050f1a9533c8414996e9cf570a5">◆ </a></span>Open() <span class="overload">[5/5]</span></h2>
+<h2 class="memtitle"><span class="permalink"><a href="#ae24d0050f1a9533c8414996e9cf570a5">◆ </a></span>Open() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
@@ -346,7 +268,15 @@ Static Public Member Functions</h2></td></tr>
</table>
</div><div class="memdoc">
-<p>Version of Open that retains ownership of stream. </p>
+<p>Open stream and retain ownership of stream object. </p>
+<dl class="params"><dt>Parameters</dt><dd>
+ <table class="params">
+ <tr><td class="paramdir">[in]</td><td class="paramname">stream</td><td>the input stream </td></tr>
+ <tr><td class="paramdir">[out]</td><td class="paramname">out</td><td>the batch reader </td></tr>
+ </table>
+ </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classarrow_1_1_status.html">Status</a> </dd></dl>
</div>
</div>
@@ -375,10 +305,10 @@ Static Public Member Functions</h2></td></tr>
</div><div class="memdoc">
<p>Read the next record batch in the stream. </p>
-<p>Return nullptr for batch when reaching end of stream</p>
+<p>Return null for batch when reaching end of stream</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
- <tr><td class="paramdir">[out]</td><td class="paramname">batch</td><td>the next loaded batch, nullptr at end of stream </td></tr>
+ <tr><td class="paramdir">[out]</td><td class="paramname">batch</td><td>the next loaded batch, null at end of stream </td></tr>
</table>
</dd>
</dl>
@@ -410,7 +340,8 @@ Static Public Member Functions</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
-<dl class="section return"><dt>Returns</dt><dd>the shared schema of the record batches in the stream </dd></dl>
+
+<p>Returns the schema read from the stream. </p>
<p>Implements <a class="el" href="classarrow_1_1_record_batch_reader.html#ad2ded865a6720e61e4685cfd34ed377f">arrow::RecordBatchReader</a>.</p>
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/35e0e750/docs/cpp/classarrow_1_1ipc_1_1_record_batch_stream_writer-members.html
----------------------------------------------------------------------
diff --git a/docs/cpp/classarrow_1_1ipc_1_1_record_batch_stream_writer-members.html b/docs/cpp/classarrow_1_1ipc_1_1_record_batch_stream_writer-members.html
index 0c1ddc4..6301ddd 100644
--- a/docs/cpp/classarrow_1_1ipc_1_1_record_batch_stream_writer-members.html
+++ b/docs/cpp/classarrow_1_1ipc_1_1_record_batch_stream_writer-members.html
@@ -73,14 +73,13 @@ $(function() {
<tr class="even"><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html#a2619ef5f3dccdb9e606a944c406ecad6">Close</a>() override</td><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html">arrow::ipc::RecordBatchStreamWriter</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html#ad1e199bbd642f0a914639e0a44bc7c4c">impl_</a></td><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html">arrow::ipc::RecordBatchStreamWriter</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html#afa77ce400799a9e9820825b38722b8de">Open</a>(io::OutputStream *sink, const std::shared_ptr< Schema > &schema, std::shared_ptr< RecordBatchWriter > *out)</td><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html">arrow::ipc::RecordBatchStreamWriter</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
- <tr><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html#aff8b31c332cc9bd7ba83275fdff081ea">Open</a>(io::OutputStream *sink, const std::shared_ptr< Schema > &schema, std::shared_ptr< RecordBatchStreamWriter > *out)</td><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html">arrow::ipc::RecordBatchStreamWriter</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
- <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html#a88e6690fbf4ee337e65577952a2f03fc">RecordBatchStreamWriter</a>()</td><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html">arrow::ipc::RecordBatchStreamWriter</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
- <tr><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html#a38780b171958b6ac66d851990c37eed2">RecordBatchStreamWriterImpl</a></td><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html">arrow::ipc::RecordBatchStreamWriter</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
- <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html#ac7c5f65e9186a192c254e2b74a36e41e">set_memory_pool</a>(MemoryPool *pool) override</td><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html">arrow::ipc::RecordBatchStreamWriter</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
- <tr><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html#af4fc0edc6dfa00ff2e70f09b916ca8d8">WriteRecordBatch</a>(const RecordBatch &batch, bool allow_64bit=false) override</td><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html">arrow::ipc::RecordBatchStreamWriter</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
- <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_writer.html#ad1d588a01d6e03df40baa283d207d00c">WriteTable</a>(const Table &table)</td><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_writer.html">arrow::ipc::RecordBatchWriter</a></td><td class="entry"></td></tr>
- <tr><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html#af84936f0d36f7f3461161d254448f9c4">~RecordBatchStreamWriter</a>()</td><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html">arrow::ipc::RecordBatchStreamWriter</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
- <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_writer.html#ac1eab409618a90045b1bba229d401f28">~RecordBatchWriter</a>()</td><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_writer.html">arrow::ipc::RecordBatchWriter</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
+ <tr><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html#a88e6690fbf4ee337e65577952a2f03fc">RecordBatchStreamWriter</a>()</td><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html">arrow::ipc::RecordBatchStreamWriter</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
+ <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html#a38780b171958b6ac66d851990c37eed2">RecordBatchStreamWriterImpl</a></td><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html">arrow::ipc::RecordBatchStreamWriter</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
+ <tr><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html#ac7c5f65e9186a192c254e2b74a36e41e">set_memory_pool</a>(MemoryPool *pool) override</td><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html">arrow::ipc::RecordBatchStreamWriter</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
+ <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html#af4fc0edc6dfa00ff2e70f09b916ca8d8">WriteRecordBatch</a>(const RecordBatch &batch, bool allow_64bit=false) override</td><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html">arrow::ipc::RecordBatchStreamWriter</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
+ <tr><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_writer.html#ad1d588a01d6e03df40baa283d207d00c">WriteTable</a>(const Table &table)</td><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_writer.html">arrow::ipc::RecordBatchWriter</a></td><td class="entry"></td></tr>
+ <tr class="even"><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html#af84936f0d36f7f3461161d254448f9c4">~RecordBatchStreamWriter</a>()</td><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html">arrow::ipc::RecordBatchStreamWriter</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
+ <tr><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_writer.html#ac1eab409618a90045b1bba229d401f28">~RecordBatchWriter</a>()</td><td class="entry"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_writer.html">arrow::ipc::RecordBatchWriter</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/35e0e750/docs/cpp/classarrow_1_1ipc_1_1_record_batch_stream_writer.html
----------------------------------------------------------------------
diff --git a/docs/cpp/classarrow_1_1ipc_1_1_record_batch_stream_writer.html b/docs/cpp/classarrow_1_1ipc_1_1_record_batch_stream_writer.html
index 984eec7..0a13b05 100644
--- a/docs/cpp/classarrow_1_1ipc_1_1_record_batch_stream_writer.html
+++ b/docs/cpp/classarrow_1_1ipc_1_1_record_batch_stream_writer.html
@@ -77,7 +77,7 @@ $(function() {
<p>Synchronous batch stream writer that writes the Arrow streaming format.
<a href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html#details">More...</a></p>
-<p><code>#include <<a class="el" href="writer_8h_source.html">writer.h</a>></code></p>
+<p><code>#include <<a class="el" href="writer_8h_source.html">arrow/ipc/writer.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for arrow::ipc::RecordBatchStreamWriter:</div>
<div class="dyncontent">
@@ -97,7 +97,7 @@ Public Member Functions</h2></td></tr>
<tr class="memdesc:af4fc0edc6dfa00ff2e70f09b916ca8d8"><td class="mdescLeft"> </td><td class="mdescRight">Write a record batch to the stream. <a href="#af4fc0edc6dfa00ff2e70f09b916ca8d8">More...</a><br /></td></tr>
<tr class="separator:af4fc0edc6dfa00ff2e70f09b916ca8d8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2619ef5f3dccdb9e606a944c406ecad6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html#a2619ef5f3dccdb9e606a944c406ecad6">Close</a> () override</td></tr>
-<tr class="memdesc:a2619ef5f3dccdb9e606a944c406ecad6"><td class="mdescLeft"> </td><td class="mdescRight">Perform any logic necessary to finish the stream. <a href="#a2619ef5f3dccdb9e606a944c406ecad6">More...</a><br /></td></tr>
+<tr class="memdesc:a2619ef5f3dccdb9e606a944c406ecad6"><td class="mdescLeft"> </td><td class="mdescRight">Close the stream by writing a 4-byte int32 0 EOS market. <a href="#a2619ef5f3dccdb9e606a944c406ecad6">More...</a><br /></td></tr>
<tr class="separator:a2619ef5f3dccdb9e606a944c406ecad6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac7c5f65e9186a192c254e2b74a36e41e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html#ac7c5f65e9186a192c254e2b74a36e41e">set_memory_pool</a> (<a class="el" href="classarrow_1_1_memory_pool.html">MemoryPool</a> *pool) override</td></tr>
<tr class="memdesc:ac7c5f65e9186a192c254e2b74a36e41e"><td class="mdescLeft"> </td><td class="mdescRight">In some cases, writing may require memory allocation. <a href="#ac7c5f65e9186a192c254e2b74a36e41e">More...</a><br /></td></tr>
@@ -111,11 +111,9 @@ Public Member Functions</h2></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
-<tr class="memitem:afa77ce400799a9e9820825b38722b8de"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html#afa77ce400799a9e9820825b38722b8de">Open</a> (<a class="el" href="classarrow_1_1io_1_1_output_stream.html">io::OutputStream</a> *sink, const std::shared_ptr< <a class="el" href="classarrow_1_1_schema.html">Schema</a> > &<a class="el" href="namespacearrow.html#ae1692c648f5447a7f95ddbe2c4e9a5fc">schema</a>, std::shared_ptr< <a class="el" href="classarrow_1_1ipc_1_1_record_batch_writer.html">RecordBatchWriter</a> > *out)</td></tr>
+<tr class="memitem:afa77ce400799a9e9820825b38722b8de"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html#afa77ce400799a9e9820825b38722b8de">Open</a> (<a class="el" href="classarrow_1_1io_1_1_output_stream.html">io::OutputStream</a> *sink, const std::shared_ptr< <a class="el" href="classarrow_1_1_schema.html">Schema</a> > &<a class="el" href="namespacearrow.html#a97ac72c2a07228577c1d38b7747941a9">schema</a>, std::shared_ptr< <a class="el" href="classarrow_1_1ipc_1_1_record_batch_writer.html">RecordBatchWriter</a> > *out)</td></tr>
<tr class="memdesc:afa77ce400799a9e9820825b38722b8de"><td class="mdescLeft"> </td><td class="mdescRight">Create a new writer from stream sink and schema. <a href="#afa77ce400799a9e9820825b38722b8de">More...</a><br /></td></tr>
<tr class="separator:afa77ce400799a9e9820825b38722b8de"><td class="memSeparator" colspan="2"> </td></tr>
-<tr class="memitem:aff8b31c332cc9bd7ba83275fdff081ea"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html#aff8b31c332cc9bd7ba83275fdff081ea">Open</a> (<a class="el" href="classarrow_1_1io_1_1_output_stream.html">io::OutputStream</a> *sink, const std::shared_ptr< <a class="el" href="classarrow_1_1_schema.html">Schema</a> > &<a class="el" href="namespacearrow.html#ae1692c648f5447a7f95ddbe2c4e9a5fc">schema</a>, std::shared_ptr< <a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html">RecordBatchStreamWriter</a> > *out)</td></tr>
-<tr class="separator:aff8b31c332cc9bd7ba83275fdff081ea"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
@@ -206,7 +204,7 @@ Protected Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
-<p>Perform any logic necessary to finish the stream. </p>
+<p>Close the stream by writing a 4-byte int32 0 EOS market. </p>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classarrow_1_1_status.html">Status</a> </dd></dl>
<p>Implements <a class="el" href="classarrow_1_1ipc_1_1_record_batch_writer.html#ad1706dac64039b5e46bf03458d65ed1a">arrow::ipc::RecordBatchWriter</a>.</p>
@@ -216,7 +214,7 @@ Protected Attributes</h2></td></tr>
</div>
</div>
<a id="afa77ce400799a9e9820825b38722b8de"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#afa77ce400799a9e9820825b38722b8de">◆ </a></span>Open() <span class="overload">[1/2]</span></h2>
+<h2 class="memtitle"><span class="permalink"><a href="#afa77ce400799a9e9820825b38722b8de">◆ </a></span>Open()</h2>
<div class="memitem">
<div class="memproto">
@@ -269,49 +267,6 @@ Protected Attributes</h2></td></tr>
</div>
</div>
-<a id="aff8b31c332cc9bd7ba83275fdff081ea"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#aff8b31c332cc9bd7ba83275fdff081ea">◆ </a></span>Open() <span class="overload">[2/2]</span></h2>
-
-<div class="memitem">
-<div class="memproto">
-<table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">static <a class="el" href="classarrow_1_1_status.html">Status</a> arrow::ipc::RecordBatchStreamWriter::Open </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="classarrow_1_1io_1_1_output_stream.html">io::OutputStream</a> * </td>
- <td class="paramname"><em>sink</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const std::shared_ptr< <a class="el" href="classarrow_1_1_schema.html">Schema</a> > & </td>
- <td class="paramname"><em>schema</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">std::shared_ptr< <a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html">RecordBatchStreamWriter</a> > * </td>
- <td class="paramname"><em>out</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
-<span class="mlabels"><span class="mlabel">static</span></span> </td>
- </tr>
-</table>
-</div><div class="memdoc">
-<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000014">Deprecated:</a></b></dt><dd>Since 0.7.0 </dd></dl>
-
-</div>
-</div>
<a id="ac7c5f65e9186a192c254e2b74a36e41e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac7c5f65e9186a192c254e2b74a36e41e">◆ </a></span>set_memory_pool()</h2>
@@ -386,7 +341,8 @@ Protected Attributes</h2></td></tr>
<p>Write a record batch to the stream. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
- <tr><td class="paramname">allow_64bit</td><td>boolean permitting field lengths exceeding INT32_MAX </td></tr>
+ <tr><td class="paramdir">[in]</td><td class="paramname">batch</td><td>the record batch to write </td></tr>
+ <tr><td class="paramdir">[in]</td><td class="paramname">allow_64bit</td><td>allow array lengths over INT32_MAX - 1 </td></tr>
</table>
</dd>
</dl>
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/35e0e750/docs/cpp/classarrow_1_1ipc_1_1_record_batch_writer.html
----------------------------------------------------------------------
diff --git a/docs/cpp/classarrow_1_1ipc_1_1_record_batch_writer.html b/docs/cpp/classarrow_1_1ipc_1_1_record_batch_writer.html
index 48b9734..65f1d63 100644
--- a/docs/cpp/classarrow_1_1ipc_1_1_record_batch_writer.html
+++ b/docs/cpp/classarrow_1_1ipc_1_1_record_batch_writer.html
@@ -74,7 +74,7 @@ $(function() {
<p>Abstract interface for writing a stream of record batches.
<a href="classarrow_1_1ipc_1_1_record_batch_writer.html#details">More...</a></p>
-<p><code>#include <<a class="el" href="writer_8h_source.html">writer.h</a>></code></p>
+<p><code>#include <<a class="el" href="writer_8h_source.html">arrow/ipc/writer.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for arrow::ipc::RecordBatchWriter:</div>
<div class="dyncontent">
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/35e0e750/docs/cpp/classarrow_1_1ipc_1_1feather_1_1_column_builder.html
----------------------------------------------------------------------
diff --git a/docs/cpp/classarrow_1_1ipc_1_1feather_1_1_column_builder.html b/docs/cpp/classarrow_1_1ipc_1_1feather_1_1_column_builder.html
index 5183884..aaa46cc 100644
--- a/docs/cpp/classarrow_1_1ipc_1_1feather_1_1_column_builder.html
+++ b/docs/cpp/classarrow_1_1ipc_1_1feather_1_1_column_builder.html
@@ -71,7 +71,7 @@ $(function() {
</div><!--header-->
<div class="contents">
-<p><code>#include <<a class="el" href="feather-internal_8h_source.html">feather-internal.h</a>></code></p>
+<p><code>#include <<a class="el" href="feather-internal_8h_source.html">arrow/ipc/feather-internal.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/35e0e750/docs/cpp/classarrow_1_1ipc_1_1feather_1_1_table_builder.html
----------------------------------------------------------------------
diff --git a/docs/cpp/classarrow_1_1ipc_1_1feather_1_1_table_builder.html b/docs/cpp/classarrow_1_1ipc_1_1feather_1_1_table_builder.html
index 0a47ca8..f32f564 100644
--- a/docs/cpp/classarrow_1_1ipc_1_1feather_1_1_table_builder.html
+++ b/docs/cpp/classarrow_1_1ipc_1_1feather_1_1_table_builder.html
@@ -72,7 +72,7 @@ $(function() {
</div><!--header-->
<div class="contents">
-<p><code>#include <<a class="el" href="feather-internal_8h_source.html">feather-internal.h</a>></code></p>
+<p><code>#include <<a class="el" href="feather-internal_8h_source.html">arrow/ipc/feather-internal.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/35e0e750/docs/cpp/classarrow_1_1ipc_1_1feather_1_1_table_metadata.html
----------------------------------------------------------------------
diff --git a/docs/cpp/classarrow_1_1ipc_1_1feather_1_1_table_metadata.html b/docs/cpp/classarrow_1_1ipc_1_1feather_1_1_table_metadata.html
index 95a9fb7..1520959 100644
--- a/docs/cpp/classarrow_1_1ipc_1_1feather_1_1_table_metadata.html
+++ b/docs/cpp/classarrow_1_1ipc_1_1feather_1_1_table_metadata.html
@@ -71,7 +71,7 @@ $(function() {
</div><!--header-->
<div class="contents">
-<p><code>#include <<a class="el" href="feather-internal_8h_source.html">feather-internal.h</a>></code></p>
+<p><code>#include <<a class="el" href="feather-internal_8h_source.html">arrow/ipc/feather-internal.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/35e0e750/docs/cpp/classarrow_1_1ipc_1_1feather_1_1_table_reader.html
----------------------------------------------------------------------
diff --git a/docs/cpp/classarrow_1_1ipc_1_1feather_1_1_table_reader.html b/docs/cpp/classarrow_1_1ipc_1_1feather_1_1_table_reader.html
index faf5444..50eec36 100644
--- a/docs/cpp/classarrow_1_1ipc_1_1feather_1_1_table_reader.html
+++ b/docs/cpp/classarrow_1_1ipc_1_1feather_1_1_table_reader.html
@@ -72,7 +72,10 @@ $(function() {
</div><!--header-->
<div class="contents">
-<p><code>#include <<a class="el" href="feather_8h_source.html">feather.h</a>></code></p>
+<p>An interface for reading columns from Feather files.
+ <a href="classarrow_1_1ipc_1_1feather_1_1_table_reader.html#details">More...</a></p>
+
+<p><code>#include <<a class="el" href="feather_8h_source.html">arrow/ipc/feather.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
@@ -81,26 +84,35 @@ Public Member Functions</h2></td></tr>
<tr class="memitem:a2db56428c818a24c3d4bcd7ddbb1c1e5"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1ipc_1_1feather_1_1_table_reader.html#a2db56428c818a24c3d4bcd7ddbb1c1e5">~TableReader</a> ()</td></tr>
<tr class="separator:a2db56428c818a24c3d4bcd7ddbb1c1e5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa725c53f94a3cd6ef282ce1905dcd320"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1ipc_1_1feather_1_1_table_reader.html#aa725c53f94a3cd6ef282ce1905dcd320">GetDescription</a> () const</td></tr>
+<tr class="memdesc:aa725c53f94a3cd6ef282ce1905dcd320"><td class="mdescLeft"> </td><td class="mdescRight">Optional table description. <a href="#aa725c53f94a3cd6ef282ce1905dcd320">More...</a><br /></td></tr>
<tr class="separator:aa725c53f94a3cd6ef282ce1905dcd320"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9993890e5a918cf5f1499d6d90f601a8"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1ipc_1_1feather_1_1_table_reader.html#a9993890e5a918cf5f1499d6d90f601a8">HasDescription</a> () const</td></tr>
+<tr class="memdesc:a9993890e5a918cf5f1499d6d90f601a8"><td class="mdescLeft"> </td><td class="mdescRight">Return true if the table has a description field populated. <a href="#a9993890e5a918cf5f1499d6d90f601a8">More...</a><br /></td></tr>
<tr class="separator:a9993890e5a918cf5f1499d6d90f601a8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a25d6ef6f2d30fe5d344e2652b75aa0df"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1ipc_1_1feather_1_1_table_reader.html#a25d6ef6f2d30fe5d344e2652b75aa0df">version</a> () const</td></tr>
+<tr class="memdesc:a25d6ef6f2d30fe5d344e2652b75aa0df"><td class="mdescLeft"> </td><td class="mdescRight">Return the version number of the Feather file. <a href="#a25d6ef6f2d30fe5d344e2652b75aa0df">More...</a><br /></td></tr>
<tr class="separator:a25d6ef6f2d30fe5d344e2652b75aa0df"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af0522c4baed022053f595cdb8fba7813"><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1ipc_1_1feather_1_1_table_reader.html#af0522c4baed022053f595cdb8fba7813">num_rows</a> () const</td></tr>
+<tr class="memdesc:af0522c4baed022053f595cdb8fba7813"><td class="mdescLeft"> </td><td class="mdescRight">Return the number of rows in the file. <a href="#af0522c4baed022053f595cdb8fba7813">More...</a><br /></td></tr>
<tr class="separator:af0522c4baed022053f595cdb8fba7813"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6355b47ca873a41f0c961e147626663a"><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1ipc_1_1feather_1_1_table_reader.html#a6355b47ca873a41f0c961e147626663a">num_columns</a> () const</td></tr>
+<tr class="memdesc:a6355b47ca873a41f0c961e147626663a"><td class="mdescLeft"> </td><td class="mdescRight">Return the number of columns in the file. <a href="#a6355b47ca873a41f0c961e147626663a">More...</a><br /></td></tr>
<tr class="separator:a6355b47ca873a41f0c961e147626663a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abebeef0907bd96ee6551e180663984be"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1ipc_1_1feather_1_1_table_reader.html#abebeef0907bd96ee6551e180663984be">GetColumnName</a> (int i) const</td></tr>
<tr class="separator:abebeef0907bd96ee6551e180663984be"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a93c9aa9e445bc157116af8e22c600d2e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1ipc_1_1feather_1_1_table_reader.html#a93c9aa9e445bc157116af8e22c600d2e">GetColumn</a> (int i, std::shared_ptr< <a class="el" href="classarrow_1_1_column.html">Column</a> > *out)</td></tr>
+<tr class="memdesc:a93c9aa9e445bc157116af8e22c600d2e"><td class="mdescLeft"> </td><td class="mdescRight">Read a column from the file as an <a class="el" href="classarrow_1_1_column.html" title="An immutable column data structure consisting of a field (type metadata) and a logical chunked data a...">arrow::Column</a>. <a href="#a93c9aa9e445bc157116af8e22c600d2e">More...</a><br /></td></tr>
<tr class="separator:a93c9aa9e445bc157116af8e22c600d2e"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:ad703b2796a5c051f00cc2a6207a0bf92"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1ipc_1_1feather_1_1_table_reader.html#ad703b2796a5c051f00cc2a6207a0bf92">Open</a> (const std::shared_ptr< <a class="el" href="classarrow_1_1io_1_1_random_access_file.html">io::RandomAccessFile</a> > &source, std::unique_ptr< <a class="el" href="classarrow_1_1ipc_1_1feather_1_1_table_reader.html">TableReader</a> > *out)</td></tr>
+<tr class="memdesc:ad703b2796a5c051f00cc2a6207a0bf92"><td class="mdescLeft"> </td><td class="mdescRight">Open a Feather file from a RandomAccessFile interface. <a href="#ad703b2796a5c051f00cc2a6207a0bf92">More...</a><br /></td></tr>
<tr class="separator:ad703b2796a5c051f00cc2a6207a0bf92"><td class="memSeparator" colspan="2"> </td></tr>
</table>
-<h2 class="groupheader">Constructor & Destructor Documentation</h2>
+<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
+<div class="textblock"><p>An interface for reading columns from Feather files. </p>
+</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a24cabf078d9fa0f526811e79f2843f69"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a24cabf078d9fa0f526811e79f2843f69">◆ </a></span>TableReader()</h2>
@@ -162,6 +174,17 @@ Static Public Member Functions</h2></td></tr>
</table>
</div><div class="memdoc">
+<p>Read a column from the file as an <a class="el" href="classarrow_1_1_column.html" title="An immutable column data structure consisting of a field (type metadata) and a logical chunked data a...">arrow::Column</a>. </p>
+<dl class="params"><dt>Parameters</dt><dd>
+ <table class="params">
+ <tr><td class="paramdir">[in]</td><td class="paramname">i</td><td>the column index to read </td></tr>
+ <tr><td class="paramdir">[out]</td><td class="paramname">out</td><td>the returned column </td></tr>
+ </table>
+ </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classarrow_1_1_status.html">Status</a></dd></dl>
+<p>This function is zero-copy if the file source supports zero-copy reads </p>
+
</div>
</div>
<a id="abebeef0907bd96ee6551e180663984be"></a>
@@ -197,6 +220,9 @@ Static Public Member Functions</h2></td></tr>
</table>
</div><div class="memdoc">
+<p>Optional table description. </p>
+<p>This does not return a const std::string& because a string has to be copied from the flatbuffer to be able to return a non-flatbuffer type </p>
+
</div>
</div>
<a id="a9993890e5a918cf5f1499d6d90f601a8"></a>
@@ -214,6 +240,8 @@ Static Public Member Functions</h2></td></tr>
</table>
</div><div class="memdoc">
+<p>Return true if the table has a description field populated. </p>
+
</div>
</div>
<a id="a6355b47ca873a41f0c961e147626663a"></a>
@@ -231,6 +259,8 @@ Static Public Member Functions</h2></td></tr>
</table>
</div><div class="memdoc">
+<p>Return the number of columns in the file. </p>
+
</div>
</div>
<a id="af0522c4baed022053f595cdb8fba7813"></a>
@@ -248,6 +278,8 @@ Static Public Member Functions</h2></td></tr>
</table>
</div><div class="memdoc">
+<p>Return the number of rows in the file. </p>
+
</div>
</div>
<a id="ad703b2796a5c051f00cc2a6207a0bf92"></a>
@@ -284,6 +316,15 @@ Static Public Member Functions</h2></td></tr>
</table>
</div><div class="memdoc">
+<p>Open a Feather file from a RandomAccessFile interface. </p>
+<dl class="params"><dt>Parameters</dt><dd>
+ <table class="params">
+ <tr><td class="paramdir">[in]</td><td class="paramname">source</td><td>a RandomAccessFile instance </td></tr>
+ <tr><td class="paramdir">[out]</td><td class="paramname">out</td><td>the table reader </td></tr>
+ </table>
+ </dd>
+</dl>
+
</div>
</div>
<a id="a25d6ef6f2d30fe5d344e2652b75aa0df"></a>
@@ -301,6 +342,8 @@ Static Public Member Functions</h2></td></tr>
</table>
</div><div class="memdoc">
+<p>Return the version number of the Feather file. </p>
+
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>