| <!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/format_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 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">format_writer.h</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="format__writer_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 <map></span></div> |
| <div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="preprocessor">#include <memory></span></div> |
| <div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="preprocessor">#include <string></span></div> |
| <div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> </div> |
| <div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#include "<a class="code" href="status_8h.html">paimon/status.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="type__fwd_8h.html">paimon/type_fwd.h</a>"</span></div> |
| <div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div> |
| <div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="keyword">struct </span><a class="code hl_struct" href="struct_arrow_array.html">ArrowArray</a>;</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">namespace </span><a class="code hl_namespace" href="namespacepaimon.html">paimon</a> {</div> |
| <div class="foldopen" id="foldopen00032" data-start="{" data-end="};"> |
| <div class="line"><a id="l00032" name="l00032"></a><span class="lineno"><a class="line" href="classpaimon_1_1_format_writer.html"> 32</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_format_writer.html">FormatWriter</a> {</div> |
| <div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">public</span>:</div> |
| <div class="line"><a id="l00034" name="l00034"></a><span class="lineno"><a class="line" href="classpaimon_1_1_format_writer.html#ad93f4f889e5f6a84e443a56032c23e33"> 34</a></span> <span class="keyword">virtual</span> <a class="code hl_function" href="classpaimon_1_1_format_writer.html#ad93f4f889e5f6a84e443a56032c23e33">~FormatWriter</a>() = <span class="keywordflow">default</span>;</div> |
| <div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> </div> |
| <div class="line"><a id="l00042" name="l00042"></a><span class="lineno"><a class="line" href="classpaimon_1_1_format_writer.html#a2e7a64e6f91b3cfb5abddd4f3c15c05e"> 42</a></span> <span class="keyword">virtual</span> <a class="code hl_class" href="classpaimon_1_1_status.html">Status</a> <a class="code hl_function" href="classpaimon_1_1_format_writer.html#a2e7a64e6f91b3cfb5abddd4f3c15c05e">AddBatch</a>(<a class="code hl_struct" href="struct_arrow_array.html">::ArrowArray</a>* <a class="code hl_define" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">batch</a>) = 0;</div> |
| <div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> </div> |
| <div class="line"><a id="l00048" name="l00048"></a><span class="lineno"><a class="line" href="classpaimon_1_1_format_writer.html#ad542d387b7ff77e9a38c782c66a7b743"> 48</a></span> <span class="keyword">virtual</span> <a class="code hl_class" href="classpaimon_1_1_status.html">Status</a> <a class="code hl_function" href="classpaimon_1_1_format_writer.html#ad542d387b7ff77e9a38c782c66a7b743">Flush</a>() = 0;</div> |
| <div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> </div> |
| <div class="line"><a id="l00060" name="l00060"></a><span class="lineno"><a class="line" href="classpaimon_1_1_format_writer.html#a5baab67a1a5a3b42a6477dc0bf8eadc7"> 60</a></span> <span class="keyword">virtual</span> <a class="code hl_class" href="classpaimon_1_1_status.html">Status</a> <a class="code hl_function" href="classpaimon_1_1_format_writer.html#a5baab67a1a5a3b42a6477dc0bf8eadc7">Finish</a>() = 0;</div> |
| <div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> </div> |
| <div class="line"><a id="l00069" name="l00069"></a><span class="lineno"><a class="line" href="classpaimon_1_1_format_writer.html#a3a2e1e327fe9bf5e8f4a3aa8bdb76a43"> 69</a></span> <span class="keyword">virtual</span> <a class="code hl_class" href="classpaimon_1_1_result.html">Result<bool></a> <a class="code hl_function" href="classpaimon_1_1_format_writer.html#a3a2e1e327fe9bf5e8f4a3aa8bdb76a43">ReachTargetSize</a>(<span class="keywordtype">bool</span> <a class="code hl_define" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">suggested_check</a>, <a class="code hl_define" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">int64_t</a> <a class="code hl_define" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">target_size</a>) <span class="keyword">const</span> = 0;</div> |
| <div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> </div> |
| <div class="line"><a id="l00073" name="l00073"></a><span class="lineno"><a class="line" href="classpaimon_1_1_format_writer.html#a87e5ca9131746f86812b1c7a45ec7536"> 73</a></span> <span class="keyword">virtual</span> std::shared_ptr<Metrics> <a class="code hl_function" href="classpaimon_1_1_format_writer.html#a87e5ca9131746f86812b1c7a45ec7536">GetWriterMetrics</a>() <span class="keyword">const</span> = 0;</div> |
| <div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> </div> |
| <div class="line"><a id="l00077" name="l00077"></a><span class="lineno"><a class="line" href="classpaimon_1_1_format_writer.html#a018a2fdde5b42bc7ed472f746f2af9f4"> 77</a></span> <span class="keyword">virtual</span> <a class="code hl_class" href="classpaimon_1_1_status.html">Status</a> <a class="code hl_function" href="classpaimon_1_1_format_writer.html#a018a2fdde5b42bc7ed472f746f2af9f4">AddMetadata</a>(<span class="keyword">const</span> std::map<std::string, std::string>& metadata) = 0;</div> |
| <div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span>};</div> |
| </div> |
| <div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> </div> |
| <div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span>} <span class="comment">// namespace paimon</span></div> |
| <div class="ttc" id="aclasspaimon_1_1_format_writer_html"><div class="ttname"><a href="classpaimon_1_1_format_writer.html">paimon::FormatWriter</a></div><div class="ttdoc">File format writer, each writer corresponds to a data file.</div><div class="ttdef"><b>Definition</b> format_writer.h:32</div></div> |
| <div class="ttc" id="aclasspaimon_1_1_format_writer_html_a018a2fdde5b42bc7ed472f746f2af9f4"><div class="ttname"><a href="classpaimon_1_1_format_writer.html#a018a2fdde5b42bc7ed472f746f2af9f4">paimon::FormatWriter::AddMetadata</a></div><div class="ttdeci">virtual Status AddMetadata(const std::map< std::string, std::string > &metadata)=0</div><div class="ttdoc">Adds metadata to the file footer.</div></div> |
| <div class="ttc" id="aclasspaimon_1_1_format_writer_html_a2e7a64e6f91b3cfb5abddd4f3c15c05e"><div class="ttname"><a href="classpaimon_1_1_format_writer.html#a2e7a64e6f91b3cfb5abddd4f3c15c05e">paimon::FormatWriter::AddBatch</a></div><div class="ttdeci">virtual Status AddBatch(::ArrowArray *batch)=0</div><div class="ttdoc">Add a batch of records to the format writer.</div></div> |
| <div class="ttc" id="aclasspaimon_1_1_format_writer_html_a3a2e1e327fe9bf5e8f4a3aa8bdb76a43"><div class="ttname"><a href="classpaimon_1_1_format_writer.html#a3a2e1e327fe9bf5e8f4a3aa8bdb76a43">paimon::FormatWriter::ReachTargetSize</a></div><div class="ttdeci">virtual Result< bool > ReachTargetSize(bool suggested_check, int64_t target_size) const =0</div><div class="ttdoc">Check if the writer has reached the target_size.</div></div> |
| <div class="ttc" id="aclasspaimon_1_1_format_writer_html_a5baab67a1a5a3b42a6477dc0bf8eadc7"><div class="ttname"><a href="classpaimon_1_1_format_writer.html#a5baab67a1a5a3b42a6477dc0bf8eadc7">paimon::FormatWriter::Finish</a></div><div class="ttdeci">virtual Status Finish()=0</div><div class="ttdoc">Finishes the writing.</div></div> |
| <div class="ttc" id="aclasspaimon_1_1_format_writer_html_a87e5ca9131746f86812b1c7a45ec7536"><div class="ttname"><a href="classpaimon_1_1_format_writer.html#a87e5ca9131746f86812b1c7a45ec7536">paimon::FormatWriter::GetWriterMetrics</a></div><div class="ttdeci">virtual std::shared_ptr< Metrics > GetWriterMetrics() const =0</div><div class="ttdoc">Get metrics of the writer.</div></div> |
| <div class="ttc" id="aclasspaimon_1_1_format_writer_html_ad542d387b7ff77e9a38c782c66a7b743"><div class="ttname"><a href="classpaimon_1_1_format_writer.html#ad542d387b7ff77e9a38c782c66a7b743">paimon::FormatWriter::Flush</a></div><div class="ttdeci">virtual Status Flush()=0</div><div class="ttdoc">Flushes all intermediate buffered data to the format writer.</div></div> |
| <div class="ttc" id="aclasspaimon_1_1_format_writer_html_ad93f4f889e5f6a84e443a56032c23e33"><div class="ttname"><a href="classpaimon_1_1_format_writer.html#ad93f4f889e5f6a84e443a56032c23e33">paimon::FormatWriter::~FormatWriter</a></div><div class="ttdeci">virtual ~FormatWriter()=default</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="aclasspaimon_1_1_status_html"><div class="ttname"><a href="classpaimon_1_1_status.html">paimon::Status</a></div><div class="ttdoc">Status outcome object (success or error)</div><div class="ttdef"><b>Definition</b> status.h:92</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:220</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="astatus_8h_html"><div class="ttname"><a href="status_8h.html">status.h</a></div></div> |
| <div class="ttc" id="astruct_arrow_array_html"><div class="ttname"><a href="struct_arrow_array.html">ArrowArray</a></div><div class="ttdef"><b>Definition</b> abi.h:69</div></div> |
| <div class="ttc" id="atype__fwd_8h_html"><div class="ttname"><a href="type__fwd_8h.html">type_fwd.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> |
