| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=11"/> |
| <meta name="generator" content="Doxygen 1.9.8"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>Paimon-cpp: paimon::Split Class 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 id="projectrow"> |
| <td id="projectalign"> |
| <div id="projectname">Paimon-cpp |
| </div> |
| <div id="projectbrief">A high-performance C++ implementation of Apache Paimon</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.9.8 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| var searchBox = new SearchBox("searchBox", "search/",'.html'); |
| /* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| $(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"> |
| <div id="MSearchResults"> |
| <div class="SRPage"> |
| <div id="SRIndex"> |
| <div id="SRResults"></div> |
| <div class="SRStatus" id="Loading">Loading...</div> |
| <div class="SRStatus" id="Searching">Searching...</div> |
| <div class="SRStatus" id="NoMatches">No Matches</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="namespacepaimon.html">paimon</a></li><li class="navelem"><a class="el" href="classpaimon_1_1_split.html">Split</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pub-static-methods">Static Public Member Functions</a> | |
| <a href="classpaimon_1_1_split-members.html">List of all members</a> </div> |
| <div class="headertitle"><div class="title">paimon::Split Class Reference</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>An input split for reading operation. |
| <a href="classpaimon_1_1_split.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="split_8h_source.html">/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/table/source/split.h</a>></code></p> |
| <div class="dynheader"> |
| Inheritance diagram for paimon::Split:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="classpaimon_1_1_split.png" usemap="#paimon::Split_map" alt=""/> |
| <map id="paimon::Split_map" name="paimon::Split_map"> |
| <area href="classpaimon_1_1_data_split.html" title="Input data split for reading operation. Needed by most batch computation engines." alt="paimon::DataSplit" shape="rect" coords="0,56,126,80"/> |
| <area href="classpaimon_1_1_indexed_split.html" title="Indexed split for global index reading operation." alt="paimon::IndexedSplit" shape="rect" coords="136,56,262,80"/> |
| </map> |
| </div></div> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:ad1bc1ca6627a627b1396991113b178b7" id="r_ad1bc1ca6627a627b1396991113b178b7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">virtual</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_split.html#ad1bc1ca6627a627b1396991113b178b7">~Split</a> ()=<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">default</a></td></tr> |
| <tr class="separator:ad1bc1ca6627a627b1396991113b178b7"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a> |
| Static Public Member Functions</h2></td></tr> |
| <tr class="memitem:aad238266c89e85852982405e60cdd9b2" id="r_aad238266c89e85852982405e60cdd9b2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">static</a> <a class="el" href="classpaimon_1_1_result.html">Result</a>< std::shared_ptr< <a class="el" href="classpaimon_1_1_split.html">Split</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_split.html#aad238266c89e85852982405e60cdd9b2">Deserialize</a> (<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">char</a> *buffer, <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">size_t</a> length, <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::shared_ptr< <a class="el" href="classpaimon_1_1_memory_pool.html">MemoryPool</a> > &pool)</td></tr> |
| <tr class="memdesc:aad238266c89e85852982405e60cdd9b2"><td class="mdescLeft"> </td><td class="mdescRight">Deserialize a <code><a class="el" href="classpaimon_1_1_split.html" title="An input split for reading operation.">Split</a></code> from a binary buffer. <br /></td></tr> |
| <tr class="separator:aad238266c89e85852982405e60cdd9b2"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a21cf471702ca3bb471eacc4bce9cf050" id="r_a21cf471702ca3bb471eacc4bce9cf050"><td class="memItemLeft" align="right" valign="top"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">static</a> <a class="el" href="classpaimon_1_1_result.html">Result</a>< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_split.html#a21cf471702ca3bb471eacc4bce9cf050">Serialize</a> (<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::shared_ptr< <a class="el" href="classpaimon_1_1_split.html">Split</a> > &<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">split</a>, <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::shared_ptr< <a class="el" href="classpaimon_1_1_memory_pool.html">MemoryPool</a> > &pool)</td></tr> |
| <tr class="memdesc:a21cf471702ca3bb471eacc4bce9cf050"><td class="mdescLeft"> </td><td class="mdescRight">Serialize a <code><a class="el" href="classpaimon_1_1_split.html" title="An input split for reading operation.">Split</a></code> to a binary string. <br /></td></tr> |
| <tr class="separator:a21cf471702ca3bb471eacc4bce9cf050"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>An input split for reading operation. </p> |
| <p>Needed by most batch computation engines. Support Serialize and Deserialize, compatible with java version. This split can be either a <code><a class="el" href="classpaimon_1_1_data_split.html" title="Input data split for reading operation. Needed by most batch computation engines.">DataSplit</a></code> (for direct data file reads) or an <code><a class="el" href="classpaimon_1_1_indexed_split.html" title="Indexed split for global index reading operation.">IndexedSplit</a></code> (for reads leveraging global indexes). </p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="ad1bc1ca6627a627b1396991113b178b7" name="ad1bc1ca6627a627b1396991113b178b7"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ad1bc1ca6627a627b1396991113b178b7">◆ </a></span>~Split()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">virtual</a> paimon::Split::~Split </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">default</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="aad238266c89e85852982405e60cdd9b2" name="aad238266c89e85852982405e60cdd9b2"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aad238266c89e85852982405e60cdd9b2">◆ </a></span>Deserialize()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">static</a> <a class="el" href="classpaimon_1_1_result.html">Result</a>< std::shared_ptr< <a class="el" href="classpaimon_1_1_split.html">Split</a> > > paimon::Split::Deserialize </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">char</a> * </td> |
| <td class="paramname"><em>buffer</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">size_t</a> </td> |
| <td class="paramname"><em>length</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::shared_ptr< <a class="el" href="classpaimon_1_1_memory_pool.html">MemoryPool</a> > & </td> |
| <td class="paramname"><em>pool</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Deserialize a <code><a class="el" href="classpaimon_1_1_split.html" title="An input split for reading operation.">Split</a></code> from a binary buffer. </p> |
| <p>Creates a <code><a class="el" href="classpaimon_1_1_split.html" title="An input split for reading operation.">Split</a></code> instance from its serialized binary representation. This is typically used in distributed computing scenarios where splits are transmitted between different nodes or processes.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">buffer</td><td>Const pointer to the binary data containing the serialized <code><a class="el" href="classpaimon_1_1_split.html" title="An input split for reading operation.">Split</a></code>. </td></tr> |
| <tr><td class="paramname">length</td><td>Size of the buffer in bytes. </td></tr> |
| <tr><td class="paramname">pool</td><td>Memory pool for allocating objects during deserialization. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd><a class="el" href="classpaimon_1_1_result.html" title="A Result<T> object holds either a value of type T or a Status object explaining why such a value is n...">Result</a> containing the deserialized <code><a class="el" href="classpaimon_1_1_split.html" title="An input split for reading operation.">Split</a></code> or an error status. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a21cf471702ca3bb471eacc4bce9cf050" name="a21cf471702ca3bb471eacc4bce9cf050"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a21cf471702ca3bb471eacc4bce9cf050">◆ </a></span>Serialize()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">static</a> <a class="el" href="classpaimon_1_1_result.html">Result</a>< std::string > paimon::Split::Serialize </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::shared_ptr< <a class="el" href="classpaimon_1_1_split.html">Split</a> > & </td> |
| <td class="paramname"><em>split</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::shared_ptr< <a class="el" href="classpaimon_1_1_memory_pool.html">MemoryPool</a> > & </td> |
| <td class="paramname"><em>pool</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Serialize a <code><a class="el" href="classpaimon_1_1_split.html" title="An input split for reading operation.">Split</a></code> to a binary string. </p> |
| <p>Converts a <code><a class="el" href="classpaimon_1_1_split.html" title="An input split for reading operation.">Split</a></code> instance to its binary representation for storage or transmission. The serialized data can later be deserialized using the Deserialize method.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">split</td><td>The <code><a class="el" href="classpaimon_1_1_split.html" title="An input split for reading operation.">Split</a></code> instance to serialize. </td></tr> |
| <tr><td class="paramname">pool</td><td>Memory pool for allocating temporary objects during serialization. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd><a class="el" href="classpaimon_1_1_result.html" title="A Result<T> object holds either a value of type T or a Status object explaining why such a value is n...">Result</a> containing the serialized binary data as a string or an error status. </dd></dl> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/table/source/<a class="el" href="split_8h_source.html">split.h</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 |
| </small></address> |
| </body> |
| </html> |
