http://git-wip-us.apache.org/repos/asf/arrow-site/blob/f508ee59/docs/cpp/arrow_2ipc_2writer_8h.html ---------------------------------------------------------------------- diff --git a/docs/cpp/arrow_2ipc_2writer_8h.html b/docs/cpp/arrow_2ipc_2writer_8h.html new file mode 100644 index 0000000..d2b612d --- /dev/null +++ b/docs/cpp/arrow_2ipc_2writer_8h.html @@ -0,0 +1,153 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> +<html xmlns="http://www.w3.org/1999/xhtml";> +<head> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<meta name="generator" content="Doxygen 1.8.14"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>Apache Arrow (C++): /arrow/cpp/src/arrow/ipc/writer.h File Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/searchdata.js"></script> +<script type="text/javascript" src="search/search.js"></script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + <td id="projectalign" style="padding-left: 0.5em;"> + <div id="projectname">Apache Arrow (C++) + </div> + <div id="projectbrief">A columnar in-memory analytics layer designed to accelerate big data.</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.14 --> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +/* @license-end */ +</script> +<script type="text/javascript" src="menudata.js"></script> +<script type="text/javascript" src="menu.js"></script> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +$(function() { + initMenu('',true,false,'search.php','Search'); + $(document).ready(function() { init_search(); }); +}); +/* @license-end */</script> +<div id="main-nav"></div> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +</div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div id="nav-path" class="navpath"> + <ul> +<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_4f683177589ce7b8fe2ef6d807198da3.html">arrow</a></li><li class="navelem"><a class="el" href="dir_e3cd57a4f30ba74550f913507c7f1d51.html">ipc</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="summary"> +<a href="#nested-classes">Classes</a> | +<a href="#namespaces">Namespaces</a> | +<a href="#func-members">Functions</a> </div> + <div class="headertitle"> +<div class="title">writer.h File Reference</div> </div> +</div><!--header--> +<div class="contents"> +<div class="textblock"><code>#include <cstdint></code><br /> +<code>#include <memory></code><br /> +<code>#include <vector></code><br /> +<code>#include "<a class="el" href="message_8h_source.html">arrow/ipc/message.h</a>"</code><br /> +<code>#include "<a class="el" href="arrow_2util_2visibility_8h_source.html">arrow/util/visibility.h</a>"</code><br /> +</div> +<p><a href="arrow_2ipc_2writer_8h_source.html">Go to the source code of this file.</a></p> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> +Classes</h2></td></tr> +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_writer.html">arrow::ipc::RecordBatchWriter</a></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Abstract interface for writing a stream of record batches. <a href="classarrow_1_1ipc_1_1_record_batch_writer.html#details">More...</a><br /></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html">arrow::ipc::RecordBatchStreamWriter</a></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">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><br /></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_file_writer.html">arrow::ipc::RecordBatchFileWriter</a></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Creates the Arrow record batch file format. <a href="classarrow_1_1ipc_1_1_record_batch_file_writer.html#details">More...</a><br /></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a> +Namespaces</h2></td></tr> +<tr class="memitem:namespacearrow"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow.html">arrow</a></td></tr> +<tr class="memdesc:namespacearrow"><td class="mdescLeft"> </td><td class="mdescRight">Top-level namespace for Apache Arrow C++ API. <br /></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:namespacearrow_1_1io"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1io.html">arrow::io</a></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:namespacearrow_1_1ipc"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1ipc.html">arrow::ipc</a></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> +Functions</h2></td></tr> +<tr class="memitem:a88fc025cbc22af0f537c96e96eb24435"><td class="memItemLeft" align="right" valign="top">Status </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1ipc.html#a88fc025cbc22af0f537c96e96eb24435">arrow::ipc::WriteRecordBatch</a> (const RecordBatch &batch, int64_t buffer_start_offset, io::OutputStream *dst, int32_t *metadata_length, int64_t *body_length, MemoryPool *pool, int max_recursion_depth=kMaxNestingDepth, bool allow_64bit=false)</td></tr> +<tr class="memdesc:a88fc025cbc22af0f537c96e96eb24435"><td class="mdescLeft"> </td><td class="mdescRight">Low-level API for writing a record batch (without schema) to an OutputStream. <a href="namespacearrow_1_1ipc.html#a88fc025cbc22af0f537c96e96eb24435">More...</a><br /></td></tr> +<tr class="separator:a88fc025cbc22af0f537c96e96eb24435"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a1c6195b676cf99ddde5c1e1a6e5abdec"><td class="memItemLeft" align="right" valign="top">Status </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1ipc.html#a1c6195b676cf99ddde5c1e1a6e5abdec">arrow::ipc::SerializeRecordBatch</a> (const RecordBatch &batch, MemoryPool *pool, std::shared_ptr< Buffer > *out)</td></tr> +<tr class="memdesc:a1c6195b676cf99ddde5c1e1a6e5abdec"><td class="mdescLeft"> </td><td class="mdescRight">Serialize record batch as encapsulated IPC message in a new buffer. <a href="namespacearrow_1_1ipc.html#a1c6195b676cf99ddde5c1e1a6e5abdec">More...</a><br /></td></tr> +<tr class="separator:a1c6195b676cf99ddde5c1e1a6e5abdec"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ab0fe4d9b40565425a1efb0a12c140ee6"><td class="memItemLeft" align="right" valign="top">Status </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1ipc.html#ab0fe4d9b40565425a1efb0a12c140ee6">arrow::ipc::SerializeRecordBatch</a> (const RecordBatch &batch, MemoryPool *pool, io::OutputStream *out)</td></tr> +<tr class="memdesc:ab0fe4d9b40565425a1efb0a12c140ee6"><td class="mdescLeft"> </td><td class="mdescRight">Write record batch to OutputStream. <a href="namespacearrow_1_1ipc.html#ab0fe4d9b40565425a1efb0a12c140ee6">More...</a><br /></td></tr> +<tr class="separator:ab0fe4d9b40565425a1efb0a12c140ee6"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aca60da7b1ad5d741c9180f5271a36b50"><td class="memItemLeft" align="right" valign="top">Status </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1ipc.html#aca60da7b1ad5d741c9180f5271a36b50">arrow::ipc::SerializeSchema</a> (const Schema &schema, MemoryPool *pool, std::shared_ptr< Buffer > *out)</td></tr> +<tr class="memdesc:aca60da7b1ad5d741c9180f5271a36b50"><td class="mdescLeft"> </td><td class="mdescRight">Serialize schema using stream writer as a sequence of one or more IPC messages. <a href="namespacearrow_1_1ipc.html#aca60da7b1ad5d741c9180f5271a36b50">More...</a><br /></td></tr> +<tr class="separator:aca60da7b1ad5d741c9180f5271a36b50"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ace91da34babf6685e5a71dcb0bb70eb5"><td class="memItemLeft" align="right" valign="top">Status </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1ipc.html#ace91da34babf6685e5a71dcb0bb70eb5">arrow::ipc::WriteRecordBatchStream</a> (const std::vector< std::shared_ptr< RecordBatch >> &batches, io::OutputStream *dst)</td></tr> +<tr class="memdesc:ace91da34babf6685e5a71dcb0bb70eb5"><td class="mdescLeft"> </td><td class="mdescRight">Write multiple record batches to OutputStream, including schema. <a href="namespacearrow_1_1ipc.html#ace91da34babf6685e5a71dcb0bb70eb5">More...</a><br /></td></tr> +<tr class="separator:ace91da34babf6685e5a71dcb0bb70eb5"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:af3e2c42f9315d51ee531d46506790291"><td class="memItemLeft" align="right" valign="top">Status </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1ipc.html#af3e2c42f9315d51ee531d46506790291">arrow::ipc::GetRecordBatchSize</a> (const RecordBatch &batch, int64_t *size)</td></tr> +<tr class="memdesc:af3e2c42f9315d51ee531d46506790291"><td class="mdescLeft"> </td><td class="mdescRight">Compute the number of bytes needed to write a record batch including metadata. <a href="namespacearrow_1_1ipc.html#af3e2c42f9315d51ee531d46506790291">More...</a><br /></td></tr> +<tr class="separator:af3e2c42f9315d51ee531d46506790291"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a8358a45c7dd8605f8ad5af4cb3216602"><td class="memItemLeft" align="right" valign="top">Status </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1ipc.html#a8358a45c7dd8605f8ad5af4cb3216602">arrow::ipc::GetTensorSize</a> (const Tensor &tensor, int64_t *size)</td></tr> +<tr class="memdesc:a8358a45c7dd8605f8ad5af4cb3216602"><td class="mdescLeft"> </td><td class="mdescRight">Compute the number of bytes needed to write a tensor including metadata. <a href="namespacearrow_1_1ipc.html#a8358a45c7dd8605f8ad5af4cb3216602">More...</a><br /></td></tr> +<tr class="separator:a8358a45c7dd8605f8ad5af4cb3216602"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aefe310d6c4b825ac1bab725c749a194f"><td class="memItemLeft" align="right" valign="top">Status </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1ipc.html#aefe310d6c4b825ac1bab725c749a194f">arrow::ipc::GetTensorMessage</a> (const Tensor &tensor, MemoryPool *pool, std::unique_ptr< Message > *out)</td></tr> +<tr class="memdesc:aefe310d6c4b825ac1bab725c749a194f"><td class="mdescLeft"> </td><td class="mdescRight">EXPERIMENTAL: Convert <a class="el" href="classarrow_1_1_tensor.html">arrow::Tensor</a> to a <a class="el" href="classarrow_1_1ipc_1_1_message.html" title="An IPC message including metadata and body. ">Message</a> with minimal memory allocation. <a href="namespacearrow_1_1ipc.html#aefe310d6c4b825ac1bab725c749a194f">More...</a><br /></td></tr> +<tr class="separator:aefe310d6c4b825ac1bab725c749a194f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aab7e08532aec7267dac70e923df75e52"><td class="memItemLeft" align="right" valign="top">Status </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1ipc.html#aab7e08532aec7267dac70e923df75e52">arrow::ipc::WriteTensor</a> (const Tensor &tensor, io::OutputStream *dst, int32_t *metadata_length, int64_t *body_length)</td></tr> +<tr class="memdesc:aab7e08532aec7267dac70e923df75e52"><td class="mdescLeft"> </td><td class="mdescRight">Write <a class="el" href="classarrow_1_1_tensor.html">arrow::Tensor</a> as a contiguous message. <a href="namespacearrow_1_1ipc.html#aab7e08532aec7267dac70e923df75e52">More...</a><br /></td></tr> +<tr class="separator:aab7e08532aec7267dac70e923df75e52"><td class="memSeparator" colspan="2"> </td></tr> +</table> +</div><!-- contents --> +<!-- HTML footer for doxygen 1.8.14--> +<!-- start footer part --> +<hr class="footer"/><address class="footer"><small> +Generated by  <a href="http://www.doxygen.org/index.html";> +<img class="footer" src="doxygen.png" alt="doxygen"/> +</a> 1.8.14 +</small></address> +<script async src="https://www.googletagmanager.com/gtag/js?id=UA-107500873-1";></script> +<script> + window.dataLayer = window.dataLayer || []; + function gtag(){dataLayer.push(arguments);} + gtag('js', new Date()); + gtag('config', 'UA-107500873-1'); +</script> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/f508ee59/docs/cpp/arrow_2ipc_2writer_8h_source.html ---------------------------------------------------------------------- diff --git a/docs/cpp/arrow_2ipc_2writer_8h_source.html b/docs/cpp/arrow_2ipc_2writer_8h_source.html new file mode 100644 index 0000000..52e6eaa --- /dev/null +++ b/docs/cpp/arrow_2ipc_2writer_8h_source.html @@ -0,0 +1,117 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> +<html xmlns="http://www.w3.org/1999/xhtml";> +<head> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<meta name="generator" content="Doxygen 1.8.14"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>Apache Arrow (C++): /arrow/cpp/src/arrow/ipc/writer.h Source File</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/searchdata.js"></script> +<script type="text/javascript" src="search/search.js"></script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + <td id="projectalign" style="padding-left: 0.5em;"> + <div id="projectname">Apache Arrow (C++) + </div> + <div id="projectbrief">A columnar in-memory analytics layer designed to accelerate big data.</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.14 --> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +/* @license-end */ +</script> +<script type="text/javascript" src="menudata.js"></script> +<script type="text/javascript" src="menu.js"></script> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +$(function() { + initMenu('',true,false,'search.php','Search'); + $(document).ready(function() { init_search(); }); +}); +/* @license-end */</script> +<div id="main-nav"></div> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +</div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div id="nav-path" class="navpath"> + <ul> +<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_4f683177589ce7b8fe2ef6d807198da3.html">arrow</a></li><li class="navelem"><a class="el" href="dir_e3cd57a4f30ba74550f913507c7f1d51.html">ipc</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="headertitle"> +<div class="title">writer.h</div> </div> +</div><!--header--> +<div class="contents"> +<a href="arrow_2ipc_2writer_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 di stributed under 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">// Implement Arrow streaming binary format</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_WRITER_H</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define ARROW_IPC_WRITER_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> <span class="preprocessor">#include <vector></span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <span class="preprocessor">#include "<a class="code" href="message_8h.html">arrow/ipc/message.h</a>"</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include "<a class="code" href="arrow_2util_2visibility_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><a class="code" href="namespaceparquet.html#abad5a6612a34e123346ad35eb4933d80">Buffer</a>;</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="ke yword">class </span>MemoryPool;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">class </span>RecordBatch;</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">class </span>Schema;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">class </span>Status;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">class </span>Table;</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="keyword">class </span>Tensor;</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="keyword">namespace </span>io {</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div><div class="line"><a name="l000 42"></a><span class="lineno"> 42</span> <span class="keyword">class </span>OutputStream;</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="comment">// namespace io</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="keyword">namespace </span>ipc {</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div><div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="classarrow_1_1ipc_1_1_record_batch_writer.html"> 50</a></span> <span class="keyword">class </span>ARROW_EXPORT <a class="code" href="classarrow_1_1ipc_1_1_record_batch_writer.html">RecordBatchWriter</a> {</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span c lass="keyword">public</span>:</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keyword">virtual</span> ~<a class="code" href="classarrow_1_1ipc_1_1_record_batch_writer.html">RecordBatchWriter</a>();</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keyword">virtual</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1ipc.html#a88fc025cbc22af0f537c96e96eb24435">WriteRecordBatch</a>(<span class="keyword">const</span> <a class="code" href="classarrow_1_1_record_batch.html">RecordBatch</a>& batch, <span class="keywordtype">bool</span> allow_64bit = <span class="keyword">false</span>) = 0;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> 0; <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespaceparquet_1_1arrow.html#a3d1297f4b7d78b7b1fea676d0e777fee">WriteTable</a>(<span class="keyword">const</span> <a class="code" href="classarrow_1_1_table.html">Table</a>& table);</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespaceparquet_1_1arrow.html#a3d1297f4b7d78b7b1fea676d0e777fee">WriteTable</a>(<span class="keyword">const</span> <a class="code" href="classarrow_1_1_table.html">Table</a>& table, int64_t max_chunksize);</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keyword">virtual</span> <a class="code" href="classarrow_1_1_status.html">Sta tus</a> Close() = 0;</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> </div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> set_memory_pool(<a class="code" href="classarrow_1_1_memory_pool.html">MemoryPool</a>* pool) = 0;</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> };</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div><div class="line"><a name="l00086"></a><span class="lineno"><a class="line" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html"> 86</a></span> <span class="keyword">class </span>ARROW_EXPORT <a class="code" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html">RecordBatchStreamWriter</a> : <span class="keyword">public</span> <a class="code" href="classarrow_1_1ipc_1_1_record_batch_writer.html">RecordBatchWriter</a> {</div><div class ="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  ~<a class="code" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html">RecordBatchStreamWriter</a>() <span class="keyword">override</span>;</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> </div><div class="line"><a name="l00097"></a><span class="lineno"> 97</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_output_stream.html">io::OutputStream</a>* sink, <span class="keyword">const</span> std::shared_ptr<Schema>& <a class="code" href="namespacearrow.html#a97ac72c2a07228577c1d38b7747941a9">schema</a>,</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  std::shared_ptr<RecordBatchWrit er>* out);</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> </div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1ipc.html#a88fc025cbc22af0f537c96e96eb24435">WriteRecordBatch</a>(<span class="keyword">const</span> <a class="code" href="classarrow_1_1_record_batch.html">RecordBatch</a>& batch, <span class="keywordtype">bool</span> allow_64bit = <span class="keyword">false</span>) <span class="keyword">override</span>;</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> </div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Close() <span class="keyword">override</span>;</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> </div><div class="line"><a name="l00111">< /a><span class="lineno"> 111</span>  <span class="keywordtype">void</span> set_memory_pool(<a class="code" href="classarrow_1_1_memory_pool.html">MemoryPool</a>* pool) <span class="keyword">override</span>;</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> </div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <span class="keyword">protected</span>:</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  <a class="code" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html">RecordBatchStreamWriter</a>();</div><div class="line"><a name="l00115"></a><span class="lineno"><a class="line" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html#a38780b171958b6ac66d851990c37eed2"> 115</a></span>  <span class="keyword">class </span><a class="code" href="arrow_2util_2visibility_8h.html#a843cb8dccea68a22a2b9995605cb5a74">ARROW_NO_EXPORT</a> RecordBatchStreamWriterImpl;</div><div class="line"><a name="l00116"></a><span class="lineno"><a class="line" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html#ad1e199bbd642f0a914639e0a44bc7c4c"> 116</a></span>  std::unique_ptr<RecordBatchStreamWriterImpl> <a class="code" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html#ad1e199bbd642f0a914639e0a44bc7c4c">impl_</a>;</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> };</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> </div><div class="line"><a name="l00124"></a><span class="lineno"><a class="line" href="classarrow_1_1ipc_1_1_record_batch_file_writer.html"> 124</a></span> <span class="keyword">class </span>ARROW_EXPORT <a class="code" href="classarrow_1_1ipc_1_1_record_batch_file_writer.html">RecordBatchFileWriter</a> : <span class="keyword">public</span> <a class="code" href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html">RecordBatchStreamWriter</a> {</div><d iv class="line"><a name="l00125"></a><span class="lineno"> 125</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  ~<a class="code" href="classarrow_1_1ipc_1_1_record_batch_file_writer.html">RecordBatchFileWriter</a>() <span class="keyword">override</span>;</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> </div><div class="line"><a name="l00134"></a><span class="lineno"> 134</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_output_stream.html">io::OutputStream</a>* sink, <span class="keyword">const</span> std::shared_ptr<Schema>& <a class="code" href="namespacearrow.html#a97ac72c2a07228577c1d38b7747941a9">schema</a>,</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  std::shared_ptr<RecordBatch Writer>* out);</div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span> </div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1ipc.html#a88fc025cbc22af0f537c96e96eb24435">WriteRecordBatch</a>(<span class="keyword">const</span> <a class="code" href="classarrow_1_1_record_batch.html">RecordBatch</a>& batch, <span class="keywordtype">bool</span> allow_64bit = <span class="keyword">false</span>) <span class="keyword">override</span>;</div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span> </div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Close() <span class="keyword">override</span>;</div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span> </div><div class="line"><a name="l0014 8"></a><span class="lineno"> 148</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  <a class="code" href="classarrow_1_1ipc_1_1_record_batch_file_writer.html">RecordBatchFileWriter</a>();</div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  <span class="keyword">class </span><a class="code" href="arrow_2util_2visibility_8h.html#a843cb8dccea68a22a2b9995605cb5a74">ARROW_NO_EXPORT</a> RecordBatchFileWriterImpl;</div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  std::unique_ptr<RecordBatchFileWriterImpl> file_impl_;</div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span> };</div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span> </div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span> ARROW_EXPORT</div><div class="line"><a name="l00181"></a><span class ="lineno"> 181</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1ipc.html#a88fc025cbc22af0f537c96e96eb24435">WriteRecordBatch</a>(<span class="keyword">const</span> <a class="code" href="classarrow_1_1_record_batch.html">RecordBatch</a>& batch, int64_t buffer_start_offset,</div><div class="line"><a name="l00182"></a><span class="lineno"> 182</span>  <a class="code" href="classarrow_1_1io_1_1_output_stream.html">io::OutputStream</a>* dst, int32_t* metadata_length,</div><div class="line"><a name="l00183"></a><span class="lineno"> 183</span>  int64_t* body_length, <a class="code" href="classarrow_1_1_memory_pool.html">MemoryPool</a>* pool,</div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span>  <span class="keywordtype">int</span> max_recursion_depth = <a class="code" href="namespacearrow_1_1ipc.html#a2dfe6a86ac 11df4637223d48d29111a9">kMaxNestingDepth</a>,</div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span>  <span class="keywordtype">bool</span> allow_64bit = <span class="keyword">false</span>);</div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span> </div><div class="line"><a name="l00193"></a><span class="lineno"> 193</span> ARROW_EXPORT</div><div class="line"><a name="l00194"></a><span class="lineno"> 194</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1ipc.html#a1c6195b676cf99ddde5c1e1a6e5abdec">SerializeRecordBatch</a>(<span class="keyword">const</span> <a class="code" href="classarrow_1_1_record_batch.html">RecordBatch</a>& batch, <a class="code" href="classarrow_1_1_memory_pool.html">MemoryPool</a>* pool,</div><div class="line"><a name="l00195"></a><span class="lineno"> 195</span>  std::shared_ptr <Buffer>* out);</div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span> </div><div class="line"><a name="l00206"></a><span class="lineno"> 206</span> ARROW_EXPORT</div><div class="line"><a name="l00207"></a><span class="lineno"> 207</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1ipc.html#a1c6195b676cf99ddde5c1e1a6e5abdec">SerializeRecordBatch</a>(<span class="keyword">const</span> <a class="code" href="classarrow_1_1_record_batch.html">RecordBatch</a>& batch, <a class="code" href="classarrow_1_1_memory_pool.html">MemoryPool</a>* pool,</div><div class="line"><a name="l00208"></a><span class="lineno"> 208</span>  <a class="code" href="classarrow_1_1io_1_1_output_stream.html">io::OutputStream</a>* out);</div><div class="line"><a name="l00209"></a><span class="lineno"> 209</span> </div><div class="line"><a name="l00217"></a><span class="lin eno"> 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#aca60da7b1ad5d741c9180f5271a36b50">SerializeSchema</a>(<span class="keyword">const</span> <a class="code" href="classarrow_1_1_schema.html">Schema</a>& <a class="code" href="namespacearrow.html#a97ac72c2a07228577c1d38b7747941a9">schema</a>, <a class="code" href="classarrow_1_1_memory_pool.html">MemoryPool</a>* pool,</div><div class="line"><a name="l00219"></a><span class="lineno"> 219</span>  std::shared_ptr<Buffer>* out);</div><div class="line"><a name="l00220"></a><span class="lineno"> 220</span> </div><div class="line"><a name="l00225"></a><span class="lineno"> 225</span> ARROW_EXPORT</div><div class="line"><a name="l00226"></a><span class="lineno"> 226</span> <a class="code" href="classarrow_1_1_sta tus.html">Status</a> <a class="code" href="namespacearrow_1_1ipc.html#ace91da34babf6685e5a71dcb0bb70eb5">WriteRecordBatchStream</a>(<span class="keyword">const</span> std::vector<std::shared_ptr<RecordBatch>>& batches,</div><div class="line"><a name="l00227"></a><span class="lineno"> 227</span>  <a class="code" href="classarrow_1_1io_1_1_output_stream.html">io::OutputStream</a>* dst);</div><div class="line"><a name="l00228"></a><span class="lineno"> 228</span> </div><div class="line"><a name="l00234"></a><span class="lineno"> 234</span> ARROW_EXPORT</div><div class="line"><a name="l00235"></a><span class="lineno"> 235</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1ipc.html#af3e2c42f9315d51ee531d46506790291">GetRecordBatchSize</a>(<span class="keyword">const</span> <a class="code" href="classarrow_1_1_record_batch.html">RecordBatch</a>& batch, int64_t* size);</div><div class="line"><a name="l00236"></a><span class="lineno"> 236</span> </div><div class="line"><a name="l00242"></a><span class="lineno"> 242</span> ARROW_EXPORT</div><div class="line"><a name="l00243"></a><span class="lineno"> 243</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1ipc.html#a8358a45c7dd8605f8ad5af4cb3216602">GetTensorSize</a>(<span class="keyword">const</span> <a class="code" href="classarrow_1_1_tensor.html">Tensor</a>& tensor, int64_t* size);</div><div class="line"><a name="l00244"></a><span class="lineno"> 244</span> </div><div class="line"><a name="l00252"></a><span class="lineno"> 252</span> ARROW_EXPORT</div><div class="line"><a name="l00253"></a><span class="lineno"> 253</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1ipc.html#aefe310d6c4b825ac1bab725c749a194f">GetTensorMessage</a>(<span cla ss="keyword">const</span> <a class="code" href="classarrow_1_1_tensor.html">Tensor</a>& tensor, <a class="code" href="classarrow_1_1_memory_pool.html">MemoryPool</a>* pool,</div><div class="line"><a name="l00254"></a><span class="lineno"> 254</span>  std::unique_ptr<Message>* out);</div><div class="line"><a name="l00255"></a><span class="lineno"> 255</span> </div><div class="line"><a name="l00268"></a><span class="lineno"> 268</span> ARROW_EXPORT</div><div class="line"><a name="l00269"></a><span class="lineno"> 269</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1ipc.html#aab7e08532aec7267dac70e923df75e52">WriteTensor</a>(<span class="keyword">const</span> <a class="code" href="classarrow_1_1_tensor.html">Tensor</a>& tensor, <a class="code" href="classarrow_1_1io_1_1_output_stream.html">io::OutputStream</a>* dst, int32_t* metadata_length,</div><div class="line"><a name="l00270"></a><span class="lineno"> 270</span>  int64_t* body_length);</div><div class="line"><a name="l00271"></a><span class="lineno"> 271</span> </div><div class="line"><a name="l00272"></a><span class="lineno"> 272</span> <span class="keyword">namespace </span>internal {</div><div class="line"><a name="l00273"></a><span class="lineno"> 273</span> </div><div class="line"><a name="l00274"></a><span class="lineno"> 274</span> <span class="comment">// These internal APIs may change without warning or deprecation</span></div><div class="line"><a name="l00275"></a><span class="lineno"> 275</span> </div><div class="line"><a name="l00276"></a><span class="lineno"> 276</span> <span class="comment">// Intermediate data structure with metadata header plus zero or more buffers</span></div><div class="line"><a name="l00277"></a><span class="lineno"> 277</span> <span class="comment">// for the message body. This data can ei ther be written out directly as an</span></div><div class="line"><a name="l00278"></a><span class="lineno"> 278</span> <span class="comment">// encapsulated IPC message or used with Flight RPCs</span></div><div class="line"><a name="l00279"></a><span class="lineno"> 279</span> <span class="keyword">struct </span>IpcPayload {</div><div class="line"><a name="l00280"></a><span class="lineno"> 280</span>  <a class="code" href="classarrow_1_1ipc_1_1_message.html#a6d6973b3b03de50d7be9dbab4db910db">Message::Type</a> type;</div><div class="line"><a name="l00281"></a><span class="lineno"> 281</span>  std::shared_ptr<Buffer> metadata;</div><div class="line"><a name="l00282"></a><span class="lineno"> 282</span>  std::vector<std::shared_ptr<Buffer>> body_buffers;</div><div class="line"><a name="l00283"></a><span class="lineno"> 283</span>  int64_t body_length;</div><div class="line"><a name="l00284"></a><span class="lineno"> 284</span>& #160;};</div><div class="line"><a name="l00285"></a><span class="lineno"> 285</span> </div><div class="line"><a name="l00288"></a><span class="lineno"> 288</span> ARROW_EXPORT</div><div class="line"><a name="l00289"></a><span class="lineno"> 289</span> <a class="code" href="classarrow_1_1_status.html">Status</a> GetDictionaryPayloads(<span class="keyword">const</span> <a class="code" href="classarrow_1_1_schema.html">Schema</a>& <a class="code" href="namespacearrow.html#a97ac72c2a07228577c1d38b7747941a9">schema</a>,</div><div class="line"><a name="l00290"></a><span class="lineno"> 290</span>  std::vector<std::unique_ptr<IpcPayload>>* out);</div><div class="line"><a name="l00291"></a><span class="lineno"> 291</span> </div><div class="line"><a name="l00297"></a><span class="lineno"> 297</span> ARROW_EXPORT</div><div class="line"><a name="l00298"></a><span class="lineno"> 298</span> <a class="code" hr ef="classarrow_1_1_status.html">Status</a> GetRecordBatchPayload(<span class="keyword">const</span> <a class="code" href="classarrow_1_1_record_batch.html">RecordBatch</a>& batch, <a class="code" href="classarrow_1_1_memory_pool.html">MemoryPool</a>* pool, IpcPayload* out);</div><div class="line"><a name="l00299"></a><span class="lineno"> 299</span> </div><div class="line"><a name="l00300"></a><span class="lineno"> 300</span> } <span class="comment">// namespace internal</span></div><div class="line"><a name="l00301"></a><span class="lineno"> 301</span> </div><div class="line"><a name="l00302"></a><span class="lineno"> 302</span> } <span class="comment">// namespace ipc</span></div><div class="line"><a name="l00303"></a><span class="lineno"> 303</span> } <span class="comment">// namespace arrow</span></div><div class="line"><a name="l00304"></a><span class="lineno"> 304</span> </div><div class="line"><a name="l00305"></a><span class="lineno "> 305</span> <span class="preprocessor">#endif // ARROW_IPC_WRITER_H</span></div><div class="ttc" id="classarrow_1_1io_1_1_output_stream_html"><div class="ttname"><a href="classarrow_1_1io_1_1_output_stream.html">arrow::io::OutputStream</a></div><div class="ttdef"><b>Definition:</b> interfaces.h:111</div></div> +<div class="ttc" id="namespacearrow_1_1ipc_html_a1c6195b676cf99ddde5c1e1a6e5abdec"><div class="ttname"><a href="namespacearrow_1_1ipc.html#a1c6195b676cf99ddde5c1e1a6e5abdec">arrow::ipc::SerializeRecordBatch</a></div><div class="ttdeci">Status SerializeRecordBatch(const RecordBatch &batch, MemoryPool *pool, std::shared_ptr< Buffer > *out)</div><div class="ttdoc">Serialize record batch as encapsulated IPC message in a new buffer. </div></div> +<div class="ttc" id="classarrow_1_1ipc_1_1_record_batch_writer_html"><div class="ttname"><a href="classarrow_1_1ipc_1_1_record_batch_writer.html">arrow::ipc::RecordBatchWriter</a></div><div class="ttdoc">Abstract interface for writing a stream of record batches. </div><div class="ttdef"><b>Definition:</b> writer.h:50</div></div> +<div class="ttc" id="namespacearrow_1_1ipc_html_a88fc025cbc22af0f537c96e96eb24435"><div class="ttname"><a href="namespacearrow_1_1ipc.html#a88fc025cbc22af0f537c96e96eb24435">arrow::ipc::WriteRecordBatch</a></div><div class="ttdeci">Status WriteRecordBatch(const RecordBatch &batch, int64_t buffer_start_offset, io::OutputStream *dst, int32_t *metadata_length, int64_t *body_length, MemoryPool *pool, int max_recursion_depth=kMaxNestingDepth, bool allow_64bit=false)</div><div class="ttdoc">Low-level API for writing a record batch (without schema) to an OutputStream. </div></div> +<div class="ttc" id="classarrow_1_1_record_batch_html"><div class="ttname"><a href="classarrow_1_1_record_batch.html">arrow::RecordBatch</a></div><div class="ttdoc">Collection of equal-length arrays matching a particular Schema. </div><div class="ttdef"><b>Definition:</b> record_batch.h:41</div></div> +<div class="ttc" id="namespacearrow_1_1ipc_html_aefe310d6c4b825ac1bab725c749a194f"><div class="ttname"><a href="namespacearrow_1_1ipc.html#aefe310d6c4b825ac1bab725c749a194f">arrow::ipc::GetTensorMessage</a></div><div class="ttdeci">Status GetTensorMessage(const Tensor &tensor, MemoryPool *pool, std::unique_ptr< Message > *out)</div><div class="ttdoc">EXPERIMENTAL: Convert arrow::Tensor to a Message with minimal memory allocation. </div></div> +<div class="ttc" id="classarrow_1_1_tensor_html"><div class="ttname"><a href="classarrow_1_1_tensor.html">arrow::Tensor</a></div><div class="ttdef"><b>Definition:</b> tensor.h:53</div></div> +<div class="ttc" id="message_8h_html"><div class="ttname"><a href="message_8h.html">message.h</a></div></div> +<div class="ttc" id="classarrow_1_1_status_html"><div class="ttname"><a href="classarrow_1_1_status.html">arrow::Status</a></div><div class="ttdef"><b>Definition:</b> status.h:95</div></div> +<div class="ttc" id="classarrow_1_1ipc_1_1_message_html_a6d6973b3b03de50d7be9dbab4db910db"><div class="ttname"><a href="classarrow_1_1ipc_1_1_message.html#a6d6973b3b03de50d7be9dbab4db910db">arrow::ipc::Message::Type</a></div><div class="ttdeci">Type</div><div class="ttdef"><b>Definition:</b> message.h:73</div></div> +<div class="ttc" id="namespacearrow_1_1ipc_html_ace91da34babf6685e5a71dcb0bb70eb5"><div class="ttname"><a href="namespacearrow_1_1ipc.html#ace91da34babf6685e5a71dcb0bb70eb5">arrow::ipc::WriteRecordBatchStream</a></div><div class="ttdeci">Status WriteRecordBatchStream(const std::vector< std::shared_ptr< RecordBatch >> &batches, io::OutputStream *dst)</div><div class="ttdoc">Write multiple record batches to OutputStream, including schema. </div></div> +<div class="ttc" id="classarrow_1_1ipc_1_1_record_batch_stream_writer_html_ad1e199bbd642f0a914639e0a44bc7c4c"><div class="ttname"><a href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html#ad1e199bbd642f0a914639e0a44bc7c4c">arrow::ipc::RecordBatchStreamWriter::impl_</a></div><div class="ttdeci">std::unique_ptr< RecordBatchStreamWriterImpl > impl_</div><div class="ttdef"><b>Definition:</b> writer.h:116</div></div> +<div class="ttc" id="classarrow_1_1ipc_1_1_record_batch_stream_writer_html"><div class="ttname"><a href="classarrow_1_1ipc_1_1_record_batch_stream_writer.html">arrow::ipc::RecordBatchStreamWriter</a></div><div class="ttdoc">Synchronous batch stream writer that writes the Arrow streaming format. </div><div class="ttdef"><b>Definition:</b> writer.h:86</div></div> +<div class="ttc" id="namespacearrow_1_1ipc_html_af3e2c42f9315d51ee531d46506790291"><div class="ttname"><a href="namespacearrow_1_1ipc.html#af3e2c42f9315d51ee531d46506790291">arrow::ipc::GetRecordBatchSize</a></div><div class="ttdeci">Status GetRecordBatchSize(const RecordBatch &batch, int64_t *size)</div><div class="ttdoc">Compute the number of bytes needed to write a record batch including metadata. </div></div> +<div class="ttc" id="classarrow_1_1ipc_1_1_record_batch_file_writer_html"><div class="ttname"><a href="classarrow_1_1ipc_1_1_record_batch_file_writer.html">arrow::ipc::RecordBatchFileWriter</a></div><div class="ttdoc">Creates the Arrow record batch file format. </div><div class="ttdef"><b>Definition:</b> writer.h:124</div></div> +<div class="ttc" id="arrow_2util_2visibility_8h_html"><div class="ttname"><a href="arrow_2util_2visibility_8h.html">visibility.h</a></div></div> +<div class="ttc" id="classarrow_1_1_schema_html"><div class="ttname"><a href="classarrow_1_1_schema.html">arrow::Schema</a></div><div class="ttdoc">Sequence of arrow::Field objects describing the columns of a record batch or table data structure...</div><div class="ttdef"><b>Definition:</b> type.h:773</div></div> +<div class="ttc" id="namespacearrow_html"><div class="ttname"><a href="namespacearrow.html">arrow</a></div><div class="ttdoc">Top-level namespace for Apache Arrow C++ API. </div><div class="ttdef"><b>Definition:</b> adapter.h:32</div></div> +<div class="ttc" id="namespacearrow_1_1ipc_html_a8358a45c7dd8605f8ad5af4cb3216602"><div class="ttname"><a href="namespacearrow_1_1ipc.html#a8358a45c7dd8605f8ad5af4cb3216602">arrow::ipc::GetTensorSize</a></div><div class="ttdeci">Status GetTensorSize(const Tensor &tensor, int64_t *size)</div><div class="ttdoc">Compute the number of bytes needed to write a tensor including metadata. </div></div> +<div class="ttc" id="namespacearrow_1_1ipc_html_aab7e08532aec7267dac70e923df75e52"><div class="ttname"><a href="namespacearrow_1_1ipc.html#aab7e08532aec7267dac70e923df75e52">arrow::ipc::WriteTensor</a></div><div class="ttdeci">Status WriteTensor(const Tensor &tensor, io::OutputStream *dst, int32_t *metadata_length, int64_t *body_length)</div><div class="ttdoc">Write arrow::Tensor as a contiguous message. </div></div> +<div class="ttc" id="arrow_2util_2visibility_8h_html_a843cb8dccea68a22a2b9995605cb5a74"><div class="ttname"><a href="arrow_2util_2visibility_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="namespacearrow_1_1ipc_html_a2dfe6a86ac11df4637223d48d29111a9"><div class="ttname"><a href="namespacearrow_1_1ipc.html#a2dfe6a86ac11df4637223d48d29111a9">arrow::ipc::kMaxNestingDepth</a></div><div class="ttdeci">constexpr int kMaxNestingDepth</div><div class="ttdef"><b>Definition:</b> message.h:63</div></div> +<div class="ttc" id="classarrow_1_1_table_html"><div class="ttname"><a href="classarrow_1_1_table.html">arrow::Table</a></div><div class="ttdoc">Logical table as sequence of chunked arrays. </div><div class="ttdef"><b>Definition:</b> table.h:167</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="classarrow_1_1_memory_pool_html"><div class="ttname"><a href="classarrow_1_1_memory_pool.html">arrow::MemoryPool</a></div><div class="ttdoc">Base class for memory allocation. </div><div class="ttdef"><b>Definition:</b> memory_pool.h:34</div></div> +<div class="ttc" id="namespacearrow_1_1ipc_html_aca60da7b1ad5d741c9180f5271a36b50"><div class="ttname"><a href="namespacearrow_1_1ipc.html#aca60da7b1ad5d741c9180f5271a36b50">arrow::ipc::SerializeSchema</a></div><div class="ttdeci">Status SerializeSchema(const Schema &schema, MemoryPool *pool, std::shared_ptr< Buffer > *out)</div><div class="ttdoc">Serialize schema using stream writer as a sequence of one or more IPC messages. </div></div> +<div class="ttc" id="namespaceparquet_html_abad5a6612a34e123346ad35eb4933d80"><div class="ttname"><a href="namespaceparquet.html#abad5a6612a34e123346ad35eb4933d80">parquet::Buffer</a></div><div class="ttdeci">::arrow::Buffer Buffer</div><div class="ttdef"><b>Definition:</b> memory.h:54</div></div> +<div class="ttc" id="namespaceparquet_1_1arrow_html_a3d1297f4b7d78b7b1fea676d0e777fee"><div class="ttname"><a href="namespaceparquet_1_1arrow.html#a3d1297f4b7d78b7b1fea676d0e777fee">parquet::arrow::WriteTable</a></div><div class="ttdeci">::arrow::Status PARQUET_EXPORT WriteTable(const ::arrow::Table &table, ::arrow::MemoryPool *pool, const std::shared_ptr<::arrow::io::OutputStream > &sink, int64_t chunk_size, const std::shared_ptr< WriterProperties > &properties=default_writer_properties(), const std::shared_ptr< ArrowWriterProperties > &arrow_properties=default_arrow_writer_properties())</div></div> +</div><!-- fragment --></div><!-- contents --> +<!-- HTML footer for doxygen 1.8.14--> +<!-- start footer part --> +<hr class="footer"/><address class="footer"><small> +Generated by  <a href="http://www.doxygen.org/index.html";> +<img class="footer" src="doxygen.png" alt="doxygen"/> +</a> 1.8.14 +</small></address> +<script async src="https://www.googletagmanager.com/gtag/js?id=UA-107500873-1";></script> +<script> + window.dataLayer = window.dataLayer || []; + function gtag(){dataLayer.push(arguments);} + gtag('js', new Date()); + gtag('config', 'UA-107500873-1'); +</script> +</body> +</html> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/f508ee59/docs/cpp/arrow_2python_2common_8h.html ---------------------------------------------------------------------- diff --git a/docs/cpp/arrow_2python_2common_8h.html b/docs/cpp/arrow_2python_2common_8h.html index 755508a..f4c8688 100644 --- a/docs/cpp/arrow_2python_2common_8h.html +++ b/docs/cpp/arrow_2python_2common_8h.html @@ -5,7 +5,7 @@ <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.14"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> -<title>Apache Arrow (C++): /apache-arrow/arrow/cpp/src/arrow/python/common.h File Reference</title> +<title>Apache Arrow (C++): /arrow/cpp/src/arrow/python/common.h File Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> @@ -81,8 +81,8 @@ $(function() { <code>#include <utility></code><br /> <code>#include "<a class="el" href="arrow_2python_2config_8h_source.html">arrow/python/config.h</a>"</code><br /> <code>#include "<a class="el" href="buffer_8h_source.html">arrow/buffer.h</a>"</code><br /> -<code>#include "<a class="el" href="macros_8h_source.html">arrow/util/macros.h</a>"</code><br /> -<code>#include "<a class="el" href="visibility_8h_source.html">arrow/util/visibility.h</a>"</code><br /> +<code>#include "<a class="el" href="arrow_2util_2macros_8h_source.html">arrow/util/macros.h</a>"</code><br /> +<code>#include "<a class="el" href="arrow_2util_2visibility_8h_source.html">arrow/util/visibility.h</a>"</code><br /> </div> <p><a href="arrow_2python_2common_8h_source.html">Go to the source code of this file.</a></p> <table class="memberdecls"> @@ -109,9 +109,9 @@ Namespaces</h2></td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a> Macros</h2></td></tr> -<tr class="memitem:ad99052ac0ced9d8a858bd49d5bfd2ebd"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="arrow_2python_2common_8h.html#ad99052ac0ced9d8a858bd49d5bfd2ebd">RETURN_IF_PYERROR</a>()   <a class="el" href="status_8h.html#a0a03bcf7fdbd9a96c67afa05fc0a545d">RETURN_NOT_OK</a>(CheckPyError());</td></tr> +<tr class="memitem:ad99052ac0ced9d8a858bd49d5bfd2ebd"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="arrow_2python_2common_8h.html#ad99052ac0ced9d8a858bd49d5bfd2ebd">RETURN_IF_PYERROR</a>()   <a class="el" href="arrow_2status_8h.html#a3d2fb237e60e56c4ce9e342e219219ee">ARROW_RETURN_NOT_OK</a>(CheckPyError());</td></tr> <tr class="separator:ad99052ac0ced9d8a858bd49d5bfd2ebd"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:acae7d13f31abc214abe5d1e7c901b72f"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="arrow_2python_2common_8h.html#acae7d13f31abc214abe5d1e7c901b72f">PY_RETURN_IF_ERROR</a>(CODE)   <a class="el" href="status_8h.html#a0a03bcf7fdbd9a96c67afa05fc0a545d">RETURN_NOT_OK</a>(CheckPyError(CODE));</td></tr> +<tr class="memitem:acae7d13f31abc214abe5d1e7c901b72f"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="arrow_2python_2common_8h.html#acae7d13f31abc214abe5d1e7c901b72f">PY_RETURN_IF_ERROR</a>(CODE)   <a class="el" href="arrow_2status_8h.html#a3d2fb237e60e56c4ce9e342e219219ee">ARROW_RETURN_NOT_OK</a>(CheckPyError(CODE));</td></tr> <tr class="separator:acae7d13f31abc214abe5d1e7c901b72f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a3736d68f2c04b7b41de8a06fb198b577"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="arrow_2python_2common_8h.html#a3736d68f2c04b7b41de8a06fb198b577">PYARROW_IS_PY2</a>   PY_MAJOR_VERSION <= 2</td></tr> <tr class="separator:a3736d68f2c04b7b41de8a06fb198b577"><td class="memSeparator" colspan="2"> </td></tr> @@ -141,7 +141,7 @@ Functions</h2></td></tr> <td>(</td> <td class="paramtype"> </td> <td class="paramname">CODE</td><td>)</td> - <td>   <a class="el" href="status_8h.html#a0a03bcf7fdbd9a96c67afa05fc0a545d">RETURN_NOT_OK</a>(CheckPyError(CODE));</td> + <td>   <a class="el" href="arrow_2status_8h.html#a3d2fb237e60e56c4ce9e342e219219ee">ARROW_RETURN_NOT_OK</a>(CheckPyError(CODE));</td> </tr> </table> </div><div class="memdoc"> @@ -172,7 +172,7 @@ Functions</h2></td></tr> <td class="memname">#define RETURN_IF_PYERROR</td> <td>(</td> <td class="paramname"></td><td>)</td> - <td>   <a class="el" href="status_8h.html#a0a03bcf7fdbd9a96c67afa05fc0a545d">RETURN_NOT_OK</a>(CheckPyError());</td> + <td>   <a class="el" href="arrow_2status_8h.html#a3d2fb237e60e56c4ce9e342e219219ee">ARROW_RETURN_NOT_OK</a>(CheckPyError());</td> </tr> </table> </div><div class="memdoc"> @@ -180,11 +180,19 @@ Functions</h2></td></tr> </div> </div> </div><!-- contents --> +<!-- HTML footer for doxygen 1.8.14--> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated by  <a href="http://www.doxygen.org/index.html";> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.14 </small></address> +<script async src="https://www.googletagmanager.com/gtag/js?id=UA-107500873-1";></script> +<script> + window.dataLayer = window.dataLayer || []; + function gtag(){dataLayer.push(arguments);} + gtag('js', new Date()); + gtag('config', 'UA-107500873-1'); +</script> </body> </html>
