| <!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: /home/runner/work/paimon-cpp/paimon-cpp/include/paimon/format/file_format.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 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> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| $(document).ready(function() { init_codefold(0); }); |
| /* @license-end */ |
| </script> |
| <!-- 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="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_d5ce83a91c1ada980bd794a9f3314520.html">paimon</a></li><li class="navelem"><a class="el" href="dir_94827ce922f878ac02e1d2e2a28038d9.html">format</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"><div class="title">file_format.h</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="file__format_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div> |
| <div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</span></div> |
| <div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * or more contributor license agreements. See the NOTICE file</span></div> |
| <div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * distributed with this work for additional information</span></div> |
| <div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * regarding copyright ownership. The ASF licenses this file</span></div> |
| <div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> * to you under the Apache License, Version 2.0 (the</span></div> |
| <div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> * "License"); you may not use this file except in compliance</span></div> |
| <div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> * with the License. You may obtain a copy of the License at</span></div> |
| <div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"> *</span></div> |
| <div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div> |
| <div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> *</span></div> |
| <div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div> |
| <div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span></div> |
| <div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div> |
| <div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> * See the License for the specific language governing permissions and</span></div> |
| <div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> * limitations under the License.</span></div> |
| <div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment"> */</span></div> |
| <div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> </div> |
| <div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="preprocessor">#pragma once</span></div> |
| <div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> </div> |
| <div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#include <memory></span></div> |
| <div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="preprocessor">#include <string></span></div> |
| <div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> </div> |
| <div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor">#include "<a class="code" href="format__stats__extractor_8h.html">paimon/format/format_stats_extractor.h</a>"</span></div> |
| <div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#include "<a class="code" href="reader__builder_8h.html">paimon/format/reader_builder.h</a>"</span></div> |
| <div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="preprocessor">#include "<a class="code" href="writer__builder_8h.html">paimon/format/writer_builder.h</a>"</span></div> |
| <div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="preprocessor">#include "<a class="code" href="memory__pool_8h.html">paimon/memory/memory_pool.h</a>"</span></div> |
| <div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="preprocessor">#include "<a class="code" href="predicate_8h.html">paimon/predicate/predicate.h</a>"</span></div> |
| <div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div> |
| <div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="keyword">struct </span><a class="code hl_struct" href="struct_arrow_schema.html">ArrowSchema</a>;</div> |
| <div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div> |
| <div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespacepaimon.html">paimon</a> {</div> |
| <div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> </div> |
| <div class="foldopen" id="foldopen00035" data-start="{" data-end="};"> |
| <div class="line"><a id="l00035" name="l00035"></a><span class="lineno"><a class="line" href="classpaimon_1_1_file_format.html"> 35</a></span><span class="keyword">class </span><a class="code hl_define" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">PAIMON_EXPORT</a> <a class="code hl_class" href="classpaimon_1_1_file_format.html">FileFormat</a> {</div> |
| <div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">public</span>:</div> |
| <div class="line"><a id="l00037" name="l00037"></a><span class="lineno"><a class="line" href="classpaimon_1_1_file_format.html#a15252abcf86e644c9cc38eb1344ac55a"> 37</a></span> <span class="keyword">virtual</span> <a class="code hl_function" href="classpaimon_1_1_file_format.html#a15252abcf86e644c9cc38eb1344ac55a">~FileFormat</a>() = <span class="keywordflow">default</span>;</div> |
| <div class="line"><a id="l00039" name="l00039"></a><span class="lineno"><a class="line" href="classpaimon_1_1_file_format.html#acfea05a4c90d05a136f3ec508347e93d"> 39</a></span> <span class="keyword">virtual</span> <span class="keyword">const</span> std::string& <a class="code hl_function" href="classpaimon_1_1_file_format.html#acfea05a4c90d05a136f3ec508347e93d">Identifier</a>() <span class="keyword">const</span> = 0;</div> |
| <div class="line"><a id="l00041" name="l00041"></a><span class="lineno"><a class="line" href="classpaimon_1_1_file_format.html#ad0921d76ee8531144b016b6bb38760cc"> 41</a></span> <span class="keyword">virtual</span> <a class="code hl_class" href="classpaimon_1_1_result.html">Result<std::unique_ptr<ReaderBuilder></a>> <a class="code hl_function" href="classpaimon_1_1_file_format.html#ad0921d76ee8531144b016b6bb38760cc">CreateReaderBuilder</a>(</div> |
| <div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <a class="code hl_define" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">int32_t</a> <a class="code hl_define" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">batch_size</a>) <span class="keyword">const</span> = 0;</div> |
| <div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> </div> |
| <div class="line"><a id="l00046" name="l00046"></a><span class="lineno"><a class="line" href="classpaimon_1_1_file_format.html#abb275a73c000c0b240118d0fbc4cc5eb"> 46</a></span> <span class="keyword">virtual</span> <a class="code hl_class" href="classpaimon_1_1_result.html">Result<std::unique_ptr<WriterBuilder></a>> <a class="code hl_function" href="classpaimon_1_1_file_format.html#abb275a73c000c0b240118d0fbc4cc5eb">CreateWriterBuilder</a>(</div> |
| <div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> <a class="code hl_struct" href="struct_arrow_schema.html">::ArrowSchema</a>* <a class="code hl_define" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">schema</a>, <a class="code hl_define" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">int32_t</a> <a class="code hl_define" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">batch_size</a>) <span class="keyword">const</span> = 0;</div> |
| <div class="line"><a id="l00049" name="l00049"></a><span class="lineno"><a class="line" href="classpaimon_1_1_file_format.html#a62e4644cc68c7b981e6edf84d280fb24"> 49</a></span> <span class="keyword">virtual</span> <a class="code hl_class" href="classpaimon_1_1_result.html">Result<std::unique_ptr<FormatStatsExtractor></a>> <a class="code hl_function" href="classpaimon_1_1_file_format.html#a62e4644cc68c7b981e6edf84d280fb24">CreateStatsExtractor</a>(</div> |
| <div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> <a class="code hl_struct" href="struct_arrow_schema.html">::ArrowSchema</a>* <a class="code hl_define" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">schema</a>) <span class="keyword">const</span> = 0;</div> |
| <div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span>};</div> |
| </div> |
| <div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> </div> |
| <div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span>} <span class="comment">// namespace paimon</span></div> |
| <div class="ttc" id="aclasspaimon_1_1_file_format_html"><div class="ttname"><a href="classpaimon_1_1_file_format.html">paimon::FileFormat</a></div><div class="ttdoc">FileFormat is used to create ReaderBuilder and WriterBuilder.</div><div class="ttdef"><b>Definition</b> file_format.h:35</div></div> |
| <div class="ttc" id="aclasspaimon_1_1_file_format_html_a15252abcf86e644c9cc38eb1344ac55a"><div class="ttname"><a href="classpaimon_1_1_file_format.html#a15252abcf86e644c9cc38eb1344ac55a">paimon::FileFormat::~FileFormat</a></div><div class="ttdeci">virtual ~FileFormat()=default</div></div> |
| <div class="ttc" id="aclasspaimon_1_1_file_format_html_a62e4644cc68c7b981e6edf84d280fb24"><div class="ttname"><a href="classpaimon_1_1_file_format.html#a62e4644cc68c7b981e6edf84d280fb24">paimon::FileFormat::CreateStatsExtractor</a></div><div class="ttdeci">virtual Result< std::unique_ptr< FormatStatsExtractor > > CreateStatsExtractor(::ArrowSchema *schema) const =0</div></div> |
| <div class="ttc" id="aclasspaimon_1_1_file_format_html_abb275a73c000c0b240118d0fbc4cc5eb"><div class="ttname"><a href="classpaimon_1_1_file_format.html#abb275a73c000c0b240118d0fbc4cc5eb">paimon::FileFormat::CreateWriterBuilder</a></div><div class="ttdeci">virtual Result< std::unique_ptr< WriterBuilder > > CreateWriterBuilder(::ArrowSchema *schema, int32_t batch_size) const =0</div></div> |
| <div class="ttc" id="aclasspaimon_1_1_file_format_html_acfea05a4c90d05a136f3ec508347e93d"><div class="ttname"><a href="classpaimon_1_1_file_format.html#acfea05a4c90d05a136f3ec508347e93d">paimon::FileFormat::Identifier</a></div><div class="ttdeci">virtual const std::string & Identifier() const =0</div></div> |
| <div class="ttc" id="aclasspaimon_1_1_file_format_html_ad0921d76ee8531144b016b6bb38760cc"><div class="ttname"><a href="classpaimon_1_1_file_format.html#ad0921d76ee8531144b016b6bb38760cc">paimon::FileFormat::CreateReaderBuilder</a></div><div class="ttdeci">virtual Result< std::unique_ptr< ReaderBuilder > > CreateReaderBuilder(int32_t batch_size) const =0</div></div> |
| <div class="ttc" id="aclasspaimon_1_1_result_html"><div class="ttname"><a href="classpaimon_1_1_result.html">paimon::Result</a></div><div class="ttdoc">A Result<T> object holds either a value of type T or a Status object explaining why such a value is n...</div><div class="ttdef"><b>Definition</b> result.h:33</div></div> |
| <div class="ttc" id="aformat__stats__extractor_8h_html"><div class="ttname"><a href="format__stats__extractor_8h.html">format_stats_extractor.h</a></div></div> |
| <div class="ttc" id="amemory__pool_8h_html"><div class="ttname"><a href="memory__pool_8h.html">memory_pool.h</a></div></div> |
| <div class="ttc" id="amemory__pool_8h_html_a147ba4ba34a215b3a4f3a95c1ee11704"><div class="ttname"><a href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">PAIMON_UNIQUE_PTR</a></div><div class="ttdeci">#define PAIMON_UNIQUE_PTR</div><div class="ttdef"><b>Definition</b> memory_pool.h:219</div></div> |
| <div class="ttc" id="anamespacepaimon_html"><div class="ttname"><a href="namespacepaimon.html">paimon</a></div><div class="ttdoc">Top-level namespace for Paimon C++ API.</div><div class="ttdef"><b>Definition</b> api.h:42</div></div> |
| <div class="ttc" id="apredicate_8h_html"><div class="ttname"><a href="predicate_8h.html">predicate.h</a></div></div> |
| <div class="ttc" id="areader__builder_8h_html"><div class="ttname"><a href="reader__builder_8h.html">reader_builder.h</a></div></div> |
| <div class="ttc" id="astruct_arrow_schema_html"><div class="ttname"><a href="struct_arrow_schema.html">ArrowSchema</a></div><div class="ttdef"><b>Definition</b> abi.h:53</div></div> |
| <div class="ttc" id="awriter__builder_8h_html"><div class="ttname"><a href="writer__builder_8h.html">writer_builder.h</a></div></div> |
| </div><!-- fragment --></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> |
