blob: 2ec4c972a9ab452dab95a372c7da35f7836bd328 [file]
<!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::DataSplit 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&amp;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&amp;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_data_split.html">DataSplit</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classpaimon_1_1_data_split-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">paimon::DataSplit Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div>
</div><!--header-->
<div class="contents">
<p>Input data split for reading operation. Needed by most batch computation engines.
<a href="classpaimon_1_1_data_split.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="data__split_8h_source.html">/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/table/source/data_split.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for paimon::DataSplit:</div>
<div class="dyncontent">
<div class="center">
<img src="classpaimon_1_1_data_split.png" usemap="#paimon::DataSplit_map" alt=""/>
<map id="paimon::DataSplit_map" name="paimon::DataSplit_map">
<area href="classpaimon_1_1_split.html" title="An input split for reading operation." alt="paimon::Split" shape="rect" coords="0,0,108,24"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structpaimon_1_1_data_split_1_1_simple_data_file_meta.html">SimpleDataFileMeta</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Metadata structure for simple data files. <a href="structpaimon_1_1_data_split_1_1_simple_data_file_meta.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:ac8a847a0c9374134bd8df653a10f8a24" id="r_ac8a847a0c9374134bd8df653a10f8a24"><td class="memItemLeft" align="right" valign="top"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">virtual</a> std::vector&lt; <a class="el" href="structpaimon_1_1_data_split_1_1_simple_data_file_meta.html">SimpleDataFileMeta</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_data_split.html#ac8a847a0c9374134bd8df653a10f8a24">GetFileList</a> () <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> =0</td></tr>
<tr class="memdesc:ac8a847a0c9374134bd8df653a10f8a24"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the list of metadata for all data files in this split. <br /></td></tr>
<tr class="separator:ac8a847a0c9374134bd8df653a10f8a24"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classpaimon_1_1_split"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classpaimon_1_1_split')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classpaimon_1_1_split.html">paimon::Split</a></td></tr>
<tr class="memitem:ad1bc1ca6627a627b1396991113b178b7 inherit pub_methods_classpaimon_1_1_split" id="r_ad1bc1ca6627a627b1396991113b178b7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">virtual</a>&#160;</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 inherit pub_methods_classpaimon_1_1_split"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_static_methods_classpaimon_1_1_split"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_classpaimon_1_1_split')"><img src="closed.png" alt="-"/>&#160;Static Public Member Functions inherited from <a class="el" href="classpaimon_1_1_split.html">paimon::Split</a></td></tr>
<tr class="memitem:aad238266c89e85852982405e60cdd9b2 inherit pub_static_methods_classpaimon_1_1_split" 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>&lt; std::shared_ptr&lt; <a class="el" href="classpaimon_1_1_split.html">Split</a> &gt; &gt;&#160;</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&lt; <a class="el" href="classpaimon_1_1_memory_pool.html">MemoryPool</a> &gt; &amp;pool)</td></tr>
<tr class="memdesc:aad238266c89e85852982405e60cdd9b2 inherit pub_static_methods_classpaimon_1_1_split"><td class="mdescLeft">&#160;</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 inherit pub_static_methods_classpaimon_1_1_split"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a21cf471702ca3bb471eacc4bce9cf050 inherit pub_static_methods_classpaimon_1_1_split" 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>&lt; std::string &gt;&#160;</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&lt; <a class="el" href="classpaimon_1_1_split.html">Split</a> &gt; &amp;<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&lt; <a class="el" href="classpaimon_1_1_memory_pool.html">MemoryPool</a> &gt; &amp;pool)</td></tr>
<tr class="memdesc:a21cf471702ca3bb471eacc4bce9cf050 inherit pub_static_methods_classpaimon_1_1_split"><td class="mdescLeft">&#160;</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 inherit pub_static_methods_classpaimon_1_1_split"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Input data split for reading operation. Needed by most batch computation engines. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="ac8a847a0c9374134bd8df653a10f8a24" name="ac8a847a0c9374134bd8df653a10f8a24"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac8a847a0c9374134bd8df653a10f8a24">&#9670;&#160;</a></span>GetFileList()</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> std::vector&lt; <a class="el" href="structpaimon_1_1_data_split_1_1_simple_data_file_meta.html">SimpleDataFileMeta</a> &gt; paimon::DataSplit::GetFileList </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the list of metadata for all data files in this split. </p>
<dl class="section note"><dt>Note</dt><dd>This method will be removed in future versions and is only used for append tables. </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="data__split_8h_source.html">data_split.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<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>