Repository: arrow-site Updated Branches: refs/heads/asf-site 3cd846826 -> 4c7c2f1b2 (forced update)
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/4c7c2f1b/docs/cpp/reader_8h_source.html ---------------------------------------------------------------------- diff --git a/docs/cpp/reader_8h_source.html b/docs/cpp/reader_8h_source.html index 26008ac..9148401 100644 --- a/docs/cpp/reader_8h_source.html +++ b/docs/cpp/reader_8h_source.html @@ -70,9 +70,9 @@ $(function() { <div class="title">reader.h</div> </div> </div><!--header--> <div class="contents"> -<a href="reader_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// Licensed to the Apache Software Foundation (ASF) under one</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// or more contributor license agreements. See the NOTICE file</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// distributed with this work for additional information</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// regarding copyright ownership. The ASF licenses this file</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// to you under the Apache License, Version 2.0 (the</span></div><div class="line"><a name="l00006"></a><span class= "lineno"> 6</span> <span class="comment">// "License"); you may not use this file except in compliance</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">// with the License. You may obtain a copy of the License at</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">//</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">//</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// Unless required by applicable law or agreed to in writing,</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// software distributed un der the License is distributed on an</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">// KIND, either express or implied. See the License for the</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">// specific language governing permissions and limitations</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">// under the License.</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">// Read Arrow files and streams</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#ifndef ARROW_IPC_READER_H</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define ARROW_IPC_READER_H</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <cstdint></span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <memory></span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include "<a class="code" href="message_8h.html">arrow/ipc/message.h</a>"</span></div><div class="line"><a name="l00027"> </a><span class="lineno"> 27</span> <span class="preprocessor">#include "<a class="code" href="record__batch_8h.html">arrow/record_batch.h</a>"</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include "<a class="code" href="visibility_8h.html">arrow/util/visibility.h</a>"</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">namespace </span><a class="code" href="namespacearrow.html">arrow</a> {</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">class </span>Buffer;</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">class </span>Schema;</div><div class="line">< a name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">class </span>Status;</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">class </span>Tensor;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">namespace </span>io {</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="keyword">class </span>InputStream;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="keyword">class </span>RandomAccessFile;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> } <span class="comment">// namespace io </span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="keyword">namespace </span>ipc {</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div><div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="namespacearrow_1_1ipc.html#a6eae3918b2e6c0c4e1f56e083187a339"> 46</a></span> <span class="keyword">using</span> <a class="code" href="classarrow_1_1_record_batch_reader.html">RecordBatchReader</a> = <a class="code" href="namespacearrow_1_1ipc.html#a6eae3918b2e6c0c4e1f56e083187a339">::arrow::RecordBatchReader</a>;</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div><div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="classarrow_1_1ipc_1_1_record_batch_stream_reader.html"> 54</a></span> <span class="keyword">class </span>A RROW_EXPORT <a class="code" href="classarrow_1_1ipc_1_1_record_batch_stream_reader.html">RecordBatchStreamReader</a> : <span class="keyword">public</span> <a class="code" href="classarrow_1_1_record_batch_reader.html">RecordBatchReader</a> {</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keyword">virtual</span> ~<a class="code" href="classarrow_1_1ipc_1_1_record_batch_stream_reader.html">RecordBatchStreamReader</a>();</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keyword">static</span> <a class="code" href="classarrow_1_1_status.html">Status</a> Open(std::unique_ptr<MessageReader> message_reader,</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&# 160; std::shared_ptr<RecordBatchReader>* out);</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keyword">static</span> <a class="code" href="classarrow_1_1_status.html">Status</a> Open(<a class="code" href="classarrow_1_1io_1_1_input_stream.html">io::InputStream</a>* stream, std::shared_ptr<RecordBatchReader>* out);</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keyword">static</span> <a class="code" href="classarrow_1_1_status.html">Status</a> Open(<span class="keyword">const</span> std::shared_ptr<io::InputStream>& stream,</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  std::shared_ptr<RecordBatchReader>* out);</div ><div class="line"><a name="l00080"></a><span class="lineno"> >80</span> </div><div class="line"><a name="l00082"></a><span >class="lineno"> 82</span>  std::shared_ptr<Schema> <a >class="code" >href="namespacearrow.html#a97ac72c2a07228577c1d38b7747941a9">schema</a>() ><span class="keyword">const override</span>;</div><div class="line"><a >name="l00083"></a><span class="lineno"> 83</span> </div><div >class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <a >class="code" href="classarrow_1_1_status.html">Status</a> >ReadNext(std::shared_ptr<RecordBatch>* batch) <span >class="keyword">override</span>;</div><div class="line"><a >name="l00085"></a><span class="lineno"> 85</span> </div><div >class="line"><a name="l00086"></a><span class="lineno"> 86</span>  ><span class="keyword">private</span>:</div><div class="line"><a >name="l00087"></a><span class="lineno"> 87</span>  <a class="code" >href="classarrow_1_1ipc_1_1_record_batc h_stream_reader.html">RecordBatchStreamReader</a>();</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> </div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keyword">class </span><a class="code" href="visibility_8h.html#a843cb8dccea68a22a2b9995605cb5a74">ARROW_NO_EXPORT</a> RecordBatchStreamReaderImpl;</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  std::unique_ptr<RecordBatchStreamReaderImpl> impl_;</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> };</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> </div><div class="line"><a name="l00094"></a><span class="lineno"><a class="line" href="classarrow_1_1ipc_1_1_record_batch_file_reader.html"> 94</a></span> <span class="keyword">class </span>ARROW_EXPORT <a class="code" href="classarrow_1_1ipc_1_1_record_batch_file_reader.html">RecordBatchFileRe ader</a> {</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  ~<a class="code" href="classarrow_1_1ipc_1_1_record_batch_file_reader.html">RecordBatchFileReader</a>();</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> </div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="keyword">static</span> <a class="code" href="classarrow_1_1_status.html">Status</a> Open(<a class="code" href="classarrow_1_1io_1_1_random_access_file.html">io::RandomAccessFile</a>* file,</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  std::shared_ptr<RecordBatchFileReader>* reader);</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> </div><div class="line"><a name="l00118"></a><span class="line no"> 118</span>  <span class="keyword">static</span> <a class="code" href="classarrow_1_1_status.html">Status</a> Open(<a class="code" href="classarrow_1_1io_1_1_random_access_file.html">io::RandomAccessFile</a>* file, int64_t footer_offset,</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  std::shared_ptr<RecordBatchFileReader>* reader);</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> </div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  <span class="keyword">static</span> <a class="code" href="classarrow_1_1_status.html">Status</a> Open(<span class="keyword">const</span> std::shared_ptr<io::RandomAccessFile>& file,</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  std::shared_ptr<RecordBatchFileReader>* reader);</div><div class="line"><a name="l00128"></a><span class="lineno"> 12 8</span> </div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  <span class="keyword">static</span> <a class="code" href="classarrow_1_1_status.html">Status</a> Open(<span class="keyword">const</span> std::shared_ptr<io::RandomAccessFile>& file,</div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  int64_t footer_offset,</div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  std::shared_ptr<RecordBatchFileReader>* reader);</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span> </div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  std::shared_ptr<Schema> <a class="code" href="namespacearrow.html#a97ac72c2a07228577c1d38b7747941a9">schema</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span> </div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  <span class="keywordtype">int</span> num_record_batches() <span class="keyword">const</span>;</div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span> </div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span>  <a class="code" href="namespacearrow_1_1ipc.html#aa5d7ec68a8c707271bab98af9bc0ac77">MetadataVersion</a> version() <span class="keyword">const</span>;</div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span> </div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1ipc.html#a62aea9cdc78753fed7578ec36a85ab44">ReadRecordBatch</a>(<span class="keywordtype">int</span> i, std::shared_ptr<RecordBatch>* batch);</div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span> </div><d iv class="line"><a name="l00156"></a><span class="lineno"> 156</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  <a class="code" href="classarrow_1_1ipc_1_1_record_batch_file_reader.html">RecordBatchFileReader</a>();</div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span> </div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  <span class="keyword">class </span><a class="code" href="visibility_8h.html#a843cb8dccea68a22a2b9995605cb5a74">ARROW_NO_EXPORT</a> RecordBatchFileReaderImpl;</div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  std::unique_ptr<RecordBatchFileReaderImpl> impl_;</div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span> };</div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span> </div><div class="line"><a name="l00163"></a><span class ="lineno"> 163</span> <span class="comment">// Generic read functions; does not copy data if the input supports zero copy reads</span></div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span> </div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span> ARROW_EXPORT</div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1ipc.html#afb612803f2eb24e01d7c3f843941e2f2">ReadSchema</a>(<a class="code" href="classarrow_1_1io_1_1_input_stream.html">io::InputStream</a>* stream, std::shared_ptr<Schema>* out);</div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span> </div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span> ARROW_EXPORT</div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span> <a class="code" href="classarrow_1_1_statu s.html">Status</a> <a class="code" href="namespacearrow_1_1ipc.html#a62aea9cdc78753fed7578ec36a85ab44">ReadRecordBatch</a>(<span class="keyword">const</span> std::shared_ptr<Schema>& <a class="code" href="namespacearrow.html#a97ac72c2a07228577c1d38b7747941a9">schema</a>, <a class="code" href="classarrow_1_1io_1_1_input_stream.html">io::InputStream</a>* stream,</div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span>  std::shared_ptr<RecordBatch>* out);</div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span> </div><div class="line"><a name="l00195"></a><span class="lineno"> 195</span> ARROW_EXPORT</div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1ipc.html#a62aea9cdc78753fed7578ec36a85ab44">ReadRecordBatch</a>(<span class="keyword">const</span> <a class="cod e" href="classarrow_1_1_buffer.html">Buffer</a>& metadata, <span class="keyword">const</span> std::shared_ptr<Schema>& <a class="code" href="namespacearrow.html#a97ac72c2a07228577c1d38b7747941a9">schema</a>,</div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span>  <a class="code" href="classarrow_1_1io_1_1_random_access_file.html">io::RandomAccessFile</a>* file, std::shared_ptr<RecordBatch>* out);</div><div class="line"><a name="l00198"></a><span class="lineno"> 198</span> </div><div class="line"><a name="l00205"></a><span class="lineno"> 205</span> ARROW_EXPORT</div><div class="line"><a name="l00206"></a><span class="lineno"> 206</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1ipc.html#a62aea9cdc78753fed7578ec36a85ab44">ReadRecordBatch</a>(<span class="keyword">const</span> <a class="code" href="classarrow_1_1ipc_1_1_message.html">Messag e</a>& message, <span class="keyword">const</span> std::shared_ptr<Schema>& <a class="code" href="namespacearrow.html#a97ac72c2a07228577c1d38b7747941a9">schema</a>,</div><div class="line"><a name="l00207"></a><span class="lineno"> 207</span>  std::shared_ptr<RecordBatch>* out);</div><div class="line"><a name="l00208"></a><span class="lineno"> 208</span> </div><div class="line"><a name="l00217"></a><span class="lineno"> 217</span> ARROW_EXPORT</div><div class="line"><a name="l00218"></a><span class="lineno"> 218</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1ipc.html#a62aea9cdc78753fed7578ec36a85ab44">ReadRecordBatch</a>(<span class="keyword">const</span> <a class="code" href="classarrow_1_1_buffer.html">Buffer</a>& metadata, <span class="keyword">const</span> std::shared_ptr<Schema>& <a class="code" href="namespacearrow.html#a97ac72c2a07228577c 1d38b7747941a9">schema</a>,</div><div class="line"><a name="l00219"></a><span class="lineno"> 219</span>  <span class="keywordtype">int</span> max_recursion_depth, <a class="code" href="classarrow_1_1io_1_1_random_access_file.html">io::RandomAccessFile</a>* file,</div><div class="line"><a name="l00220"></a><span class="lineno"> 220</span>  std::shared_ptr<RecordBatch>* out);</div><div class="line"><a name="l00221"></a><span class="lineno"> 221</span> </div><div class="line"><a name="l00228"></a><span class="lineno"> 228</span> ARROW_EXPORT</div><div class="line"><a name="l00229"></a><span class="lineno"> 229</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1ipc.html#a20b096f3dbfbbd4d78a1383b2a1ff84a">ReadTensor</a>(int64_t offset, <a class="code" href="classarrow_1_1io_1_1_random_access_file.html">io::RandomAccessFile</a>* file,</div><div class="l ine"><a name="l00230"></a><span class="lineno"> 230</span>  std::shared_ptr<Tensor>* out);</div><div class="line"><a name="l00231"></a><span class="lineno"> 231</span> </div><div class="line"><a name="l00237"></a><span class="lineno"> 237</span> ARROW_EXPORT</div><div class="line"><a name="l00238"></a><span class="lineno"> 238</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1ipc.html#a20b096f3dbfbbd4d78a1383b2a1ff84a">ReadTensor</a>(<span class="keyword">const</span> <a class="code" href="classarrow_1_1ipc_1_1_message.html">Message</a>& message, std::shared_ptr<Tensor>* out);</div><div class="line"><a name="l00239"></a><span class="lineno"> 239</span> </div><div class="line"><a name="l00240"></a><span class="lineno"> 240</span> } <span class="comment">// namespace ipc</span></div><div class="line"><a name="l00241"></a><span class="lineno"> 241</span>  ;} <span class="comment">// namespace arrow</span></div><div class="line"><a name="l00242"></a><span class="lineno"> 242</span> </div><div class="line"><a name="l00243"></a><span class="lineno"> 243</span> <span class="preprocessor">#endif // ARROW_IPC_READER_H</span></div><div class="ttc" id="namespacearrow_1_1ipc_html_a20b096f3dbfbbd4d78a1383b2a1ff84a"><div class="ttname"><a href="namespacearrow_1_1ipc.html#a20b096f3dbfbbd4d78a1383b2a1ff84a">arrow::ipc::ReadTensor</a></div><div class="ttdeci">Status ReadTensor(int64_t offset, io::RandomAccessFile *file, std::shared_ptr< Tensor > *out)</div><div class="ttdoc">EXPERIMENTAL: Read arrow::Tensor as encapsulated IPC message in file. </div></div> +<a href="reader_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// Licensed to the Apache Software Foundation (ASF) under one</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// or more contributor license agreements. See the NOTICE file</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// distributed with this work for additional information</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// regarding copyright ownership. The ASF licenses this file</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// to you under the Apache License, Version 2.0 (the</span></div><div class="line"><a name="l00006"></a><span class= "lineno"> 6</span> <span class="comment">// "License"); you may not use this file except in compliance</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">// with the License. You may obtain a copy of the License at</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">//</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">//</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// Unless required by applicable law or agreed to in writing,</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// software distributed un der the License is distributed on an</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">// KIND, either express or implied. See the License for the</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">// specific language governing permissions and limitations</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">// under the License.</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">// Read Arrow files and streams</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#ifndef ARROW_IPC_READER_H</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define ARROW_IPC_READER_H</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <cstdint></span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <memory></span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include "<a class="code" href="message_8h.html">arrow/ipc/message.h</a>"</span></div><div class="line"><a name="l00027"> </a><span class="lineno"> 27</span> <span class="preprocessor">#include "<a class="code" href="record__batch_8h.html">arrow/record_batch.h</a>"</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include "<a class="code" href="visibility_8h.html">arrow/util/visibility.h</a>"</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">namespace </span><a class="code" href="namespacearrow.html">arrow</a> {</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">class </span>Buffer;</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">class </span>Schema;</div><div class="line">< a name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">class </span>Status;</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">class </span>Tensor;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">namespace </span>io {</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="keyword">class </span>InputStream;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="keyword">class </span>RandomAccessFile;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> } <span class="comment">// namespace io </span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="keyword">namespace </span>ipc {</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div><div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="namespacearrow_1_1ipc.html#a6eae3918b2e6c0c4e1f56e083187a339"> 46</a></span> <span class="keyword">using</span> <a class="code" href="classarrow_1_1_record_batch_reader.html">RecordBatchReader</a> = <a class="code" href="namespacearrow_1_1ipc.html#a6eae3918b2e6c0c4e1f56e083187a339">::arrow::RecordBatchReader</a>;</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div><div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="classarrow_1_1ipc_1_1_record_batch_stream_reader.html"> 54</a></span> <span class="keyword">class </span>A RROW_EXPORT <a class="code" href="classarrow_1_1ipc_1_1_record_batch_stream_reader.html">RecordBatchStreamReader</a> : <span class="keyword">public</span> <a class="code" href="classarrow_1_1_record_batch_reader.html">RecordBatchReader</a> {</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  ~<a class="code" href="classarrow_1_1ipc_1_1_record_batch_stream_reader.html">RecordBatchStreamReader</a>() <span class="keyword">override</span>;</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keyword">static</span> <a class="code" href="classarrow_1_1_status.html">Status</a> Open(std::unique_ptr<MessageReader> message_reader,</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>& #160; std::shared_ptr<RecordBatchReader>* out);</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keyword">static</span> <a class="code" href="classarrow_1_1_status.html">Status</a> Open(<a class="code" href="classarrow_1_1io_1_1_input_stream.html">io::InputStream</a>* stream, std::shared_ptr<RecordBatchReader>* out);</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keyword">static</span> <a class="code" href="classarrow_1_1_status.html">Status</a> Open(<span class="keyword">const</span> std::shared_ptr<io::InputStream>& stream,</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  std::shared_ptr<RecordBatchReader>* out);</di v><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  std::shared_ptr<Schema> <a class="code" href="namespacearrow.html#a97ac72c2a07228577c1d38b7747941a9">schema</a>() <span class="keyword">const override</span>;</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> </div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> ReadNext(std::shared_ptr<RecordBatch>* batch) <span class="keyword">override</span>;</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> </div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <a class="code" href="classarrow_1_1ipc_1_1_record_bat ch_stream_reader.html">RecordBatchStreamReader</a>();</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> </div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keyword">class </span><a class="code" href="visibility_8h.html#a843cb8dccea68a22a2b9995605cb5a74">ARROW_NO_EXPORT</a> RecordBatchStreamReaderImpl;</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  std::unique_ptr<RecordBatchStreamReaderImpl> impl_;</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> };</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> </div><div class="line"><a name="l00094"></a><span class="lineno"><a class="line" href="classarrow_1_1ipc_1_1_record_batch_file_reader.html"> 94</a></span> <span class="keyword">class </span>ARROW_EXPORT <a class="code" href="classarrow_1_1ipc_1_1_record_batch_file_reader.html">RecordBatchFileR eader</a> {</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  ~<a class="code" href="classarrow_1_1ipc_1_1_record_batch_file_reader.html">RecordBatchFileReader</a>();</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> </div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="keyword">static</span> <a class="code" href="classarrow_1_1_status.html">Status</a> Open(<a class="code" href="classarrow_1_1io_1_1_random_access_file.html">io::RandomAccessFile</a>* file,</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  std::shared_ptr<RecordBatchFileReader>* reader);</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> </div><div class="line"><a name="l00118"></a><span class="lin eno"> 118</span>  <span class="keyword">static</span> <a class="code" href="classarrow_1_1_status.html">Status</a> Open(<a class="code" href="classarrow_1_1io_1_1_random_access_file.html">io::RandomAccessFile</a>* file, int64_t footer_offset,</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  std::shared_ptr<RecordBatchFileReader>* reader);</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> </div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  <span class="keyword">static</span> <a class="code" href="classarrow_1_1_status.html">Status</a> Open(<span class="keyword">const</span> std::shared_ptr<io::RandomAccessFile>& file,</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  std::shared_ptr<RecordBatchFileReader>* reader);</div><div class="line"><a name="l00128"></a><span class="lineno"> 1 28</span> </div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  <span class="keyword">static</span> <a class="code" href="classarrow_1_1_status.html">Status</a> Open(<span class="keyword">const</span> std::shared_ptr<io::RandomAccessFile>& file,</div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  int64_t footer_offset,</div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  std::shared_ptr<RecordBatchFileReader>* reader);</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span> </div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  std::shared_ptr<Schema> <a class="code" href="namespacearrow.html#a97ac72c2a07228577c1d38b7747941a9">schema</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span> </div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  <span class="keywordtype">int</span> num_record_batches() <span class="keyword">const</span>;</div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span> </div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span>  <a class="code" href="namespacearrow_1_1ipc.html#aa5d7ec68a8c707271bab98af9bc0ac77">MetadataVersion</a> version() <span class="keyword">const</span>;</div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span> </div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1ipc.html#a62aea9cdc78753fed7578ec36a85ab44">ReadRecordBatch</a>(<span class="keywordtype">int</span> i, std::shared_ptr<RecordBatch>* batch);</div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span> </div>< div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  <a class="code" href="classarrow_1_1ipc_1_1_record_batch_file_reader.html">RecordBatchFileReader</a>();</div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span> </div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  <span class="keyword">class </span><a class="code" href="visibility_8h.html#a843cb8dccea68a22a2b9995605cb5a74">ARROW_NO_EXPORT</a> RecordBatchFileReaderImpl;</div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  std::unique_ptr<RecordBatchFileReaderImpl> impl_;</div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span> };</div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span> </div><div class="line"><a name="l00163"></a><span clas s="lineno"> 163</span> <span class="comment">// Generic read functions; does not copy data if the input supports zero copy reads</span></div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span> </div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span> ARROW_EXPORT</div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1ipc.html#afb612803f2eb24e01d7c3f843941e2f2">ReadSchema</a>(<a class="code" href="classarrow_1_1io_1_1_input_stream.html">io::InputStream</a>* stream, std::shared_ptr<Schema>* out);</div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span> </div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span> ARROW_EXPORT</div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span> <a class="code" href="classarrow_1_1_stat us.html">Status</a> <a class="code" href="namespacearrow_1_1ipc.html#a62aea9cdc78753fed7578ec36a85ab44">ReadRecordBatch</a>(<span class="keyword">const</span> std::shared_ptr<Schema>& <a class="code" href="namespacearrow.html#a97ac72c2a07228577c1d38b7747941a9">schema</a>, <a class="code" href="classarrow_1_1io_1_1_input_stream.html">io::InputStream</a>* stream,</div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span>  std::shared_ptr<RecordBatch>* out);</div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span> </div><div class="line"><a name="l00195"></a><span class="lineno"> 195</span> ARROW_EXPORT</div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1ipc.html#a62aea9cdc78753fed7578ec36a85ab44">ReadRecordBatch</a>(<span class="keyword">const</span> <a class="co de" href="classarrow_1_1_buffer.html">Buffer</a>& metadata, <span class="keyword">const</span> std::shared_ptr<Schema>& <a class="code" href="namespacearrow.html#a97ac72c2a07228577c1d38b7747941a9">schema</a>,</div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span>  <a class="code" href="classarrow_1_1io_1_1_random_access_file.html">io::RandomAccessFile</a>* file, std::shared_ptr<RecordBatch>* out);</div><div class="line"><a name="l00198"></a><span class="lineno"> 198</span> </div><div class="line"><a name="l00205"></a><span class="lineno"> 205</span> ARROW_EXPORT</div><div class="line"><a name="l00206"></a><span class="lineno"> 206</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1ipc.html#a62aea9cdc78753fed7578ec36a85ab44">ReadRecordBatch</a>(<span class="keyword">const</span> <a class="code" href="classarrow_1_1ipc_1_1_message.html">Messa ge</a>& message, <span class="keyword">const</span> std::shared_ptr<Schema>& <a class="code" href="namespacearrow.html#a97ac72c2a07228577c1d38b7747941a9">schema</a>,</div><div class="line"><a name="l00207"></a><span class="lineno"> 207</span>  std::shared_ptr<RecordBatch>* out);</div><div class="line"><a name="l00208"></a><span class="lineno"> 208</span> </div><div class="line"><a name="l00217"></a><span class="lineno"> 217</span> ARROW_EXPORT</div><div class="line"><a name="l00218"></a><span class="lineno"> 218</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1ipc.html#a62aea9cdc78753fed7578ec36a85ab44">ReadRecordBatch</a>(<span class="keyword">const</span> <a class="code" href="classarrow_1_1_buffer.html">Buffer</a>& metadata, <span class="keyword">const</span> std::shared_ptr<Schema>& <a class="code" href="namespacearrow.html#a97ac72c2a07228577 c1d38b7747941a9">schema</a>,</div><div class="line"><a name="l00219"></a><span class="lineno"> 219</span>  <span class="keywordtype">int</span> max_recursion_depth, <a class="code" href="classarrow_1_1io_1_1_random_access_file.html">io::RandomAccessFile</a>* file,</div><div class="line"><a name="l00220"></a><span class="lineno"> 220</span>  std::shared_ptr<RecordBatch>* out);</div><div class="line"><a name="l00221"></a><span class="lineno"> 221</span> </div><div class="line"><a name="l00228"></a><span class="lineno"> 228</span> ARROW_EXPORT</div><div class="line"><a name="l00229"></a><span class="lineno"> 229</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1ipc.html#a20b096f3dbfbbd4d78a1383b2a1ff84a">ReadTensor</a>(int64_t offset, <a class="code" href="classarrow_1_1io_1_1_random_access_file.html">io::RandomAccessFile</a>* file,</div><div class=" line"><a name="l00230"></a><span class="lineno"> 230</span>  std::shared_ptr<Tensor>* out);</div><div class="line"><a name="l00231"></a><span class="lineno"> 231</span> </div><div class="line"><a name="l00237"></a><span class="lineno"> 237</span> ARROW_EXPORT</div><div class="line"><a name="l00238"></a><span class="lineno"> 238</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1ipc.html#a20b096f3dbfbbd4d78a1383b2a1ff84a">ReadTensor</a>(<span class="keyword">const</span> <a class="code" href="classarrow_1_1ipc_1_1_message.html">Message</a>& message, std::shared_ptr<Tensor>* out);</div><div class="line"><a name="l00239"></a><span class="lineno"> 239</span> </div><div class="line"><a name="l00240"></a><span class="lineno"> 240</span> } <span class="comment">// namespace ipc</span></div><div class="line"><a name="l00241"></a><span class="lineno"> 241</span> 0;} <span class="comment">// namespace arrow</span></div><div class="line"><a name="l00242"></a><span class="lineno"> 242</span> </div><div class="line"><a name="l00243"></a><span class="lineno"> 243</span> <span class="preprocessor">#endif // ARROW_IPC_READER_H</span></div><div class="ttc" id="namespacearrow_1_1ipc_html_a20b096f3dbfbbd4d78a1383b2a1ff84a"><div class="ttname"><a href="namespacearrow_1_1ipc.html#a20b096f3dbfbbd4d78a1383b2a1ff84a">arrow::ipc::ReadTensor</a></div><div class="ttdeci">Status ReadTensor(int64_t offset, io::RandomAccessFile *file, std::shared_ptr< Tensor > *out)</div><div class="ttdoc">EXPERIMENTAL: Read arrow::Tensor as encapsulated IPC message in file. </div></div> <div class="ttc" id="classarrow_1_1ipc_1_1_message_html"><div class="ttname"><a href="classarrow_1_1ipc_1_1_message.html">arrow::ipc::Message</a></div><div class="ttdoc">An IPC message including metadata and body. </div><div class="ttdef"><b>Definition:</b> message.h:70</div></div> -<div class="ttc" id="classarrow_1_1_record_batch_reader_html"><div class="ttname"><a href="classarrow_1_1_record_batch_reader.html">arrow::RecordBatchReader</a></div><div class="ttdoc">Abstract interface for reading stream of record batches. </div><div class="ttdef"><b>Definition:</b> record_batch.h:137</div></div> +<div class="ttc" id="classarrow_1_1_record_batch_reader_html"><div class="ttname"><a href="classarrow_1_1_record_batch_reader.html">arrow::RecordBatchReader</a></div><div class="ttdoc">Abstract interface for reading stream of record batches. </div><div class="ttdef"><b>Definition:</b> record_batch.h:166</div></div> <div class="ttc" id="classarrow_1_1io_1_1_input_stream_html"><div class="ttname"><a href="classarrow_1_1io_1_1_input_stream.html">arrow::io::InputStream</a></div><div class="ttdef"><b>Definition:</b> interfaces.h:116</div></div> <div class="ttc" id="visibility_8h_html_a843cb8dccea68a22a2b9995605cb5a74"><div class="ttname"><a href="visibility_8h.html#a843cb8dccea68a22a2b9995605cb5a74">ARROW_NO_EXPORT</a></div><div class="ttdeci">#define ARROW_NO_EXPORT</div><div class="ttdef"><b>Definition:</b> visibility.h:42</div></div> <div class="ttc" id="classarrow_1_1io_1_1_random_access_file_html"><div class="ttname"><a href="classarrow_1_1io_1_1_random_access_file.html">arrow::io::RandomAccessFile</a></div><div class="ttdef"><b>Definition:</b> interfaces.h:121</div></div> @@ -88,7 +88,7 @@ $(function() { <div class="ttc" id="namespacearrow_1_1ipc_html_aa5d7ec68a8c707271bab98af9bc0ac77"><div class="ttname"><a href="namespacearrow_1_1ipc.html#aa5d7ec68a8c707271bab98af9bc0ac77">arrow::ipc::MetadataVersion</a></div><div class="ttdeci">MetadataVersion</div><div class="ttdef"><b>Definition:</b> message.h:45</div></div> <div class="ttc" id="namespacearrow_html_a97ac72c2a07228577c1d38b7747941a9"><div class="ttname"><a href="namespacearrow.html#a97ac72c2a07228577c1d38b7747941a9">arrow::schema</a></div><div class="ttdeci">std::shared_ptr< Schema > schema(const std::vector< std::shared_ptr< Field >> &fields, const std::shared_ptr< const KeyValueMetadata > &metadata=NULLPTR)</div><div class="ttdoc">Create a Schema instance. </div></div> <div class="ttc" id="namespacearrow_1_1ipc_html_afb612803f2eb24e01d7c3f843941e2f2"><div class="ttname"><a href="namespacearrow_1_1ipc.html#afb612803f2eb24e01d7c3f843941e2f2">arrow::ipc::ReadSchema</a></div><div class="ttdeci">Status ReadSchema(io::InputStream *stream, std::shared_ptr< Schema > *out)</div><div class="ttdoc">Read Schema from stream serialized as a sequence of one or more IPC messages. </div></div> -<div class="ttc" id="classarrow_1_1_buffer_html"><div class="ttname"><a href="classarrow_1_1_buffer.html">arrow::Buffer</a></div><div class="ttdoc">Immutable API for a chunk of bytes which may or may not be owned by the class instance. </div><div class="ttdef"><b>Definition:</b> buffer.h:48</div></div> +<div class="ttc" id="classarrow_1_1_buffer_html"><div class="ttname"><a href="classarrow_1_1_buffer.html">arrow::Buffer</a></div><div class="ttdoc">Object containing a pointer to a piece of contiguous memory with a particular size. </div><div class="ttdef"><b>Definition:</b> buffer.h:48</div></div> </div><!-- fragment --></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small>
