| <!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>iceberg-cpp: iceberg/data/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">iceberg-cpp |
| </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_51d145386ec5f52aa06ebf5e46944abc.html">iceberg</a></li><li class="navelem"><a class="el" href="dir_40a892c7cf92893422212651b7511047.html">data</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="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,</span></div> |
| <div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> * software distributed under the License is distributed on an</span></div> |
| <div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div> |
| <div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> * KIND, either express or implied. See the License for the</span></div> |
| <div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> * specific language governing permissions and limitations</span></div> |
| <div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment"> * under the License.</span></div> |
| <div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment"> */</span></div> |
| <div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div> |
| <div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#pragma once</span></div> |
| <div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</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 <cstdint></span></div> |
| <div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="preprocessor">#include <memory></span></div> |
| <div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="preprocessor">#include <string></span></div> |
| <div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="preprocessor">#include <vector></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="preprocessor">#include "<a class="code" href="arrow__c__data_8h.html">iceberg/arrow_c_data.h</a>"</span></div> |
| <div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="preprocessor">#include "<a class="code" href="iceberg__data__export_8h.html">iceberg/iceberg_data_export.h</a>"</span></div> |
| <div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="preprocessor">#include "<a class="code" href="result_8h.html">iceberg/result.h</a>"</span></div> |
| <div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="preprocessor">#include "<a class="code" href="type__fwd_8h.html">iceberg/type_fwd.h</a>"</span></div> |
| <div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> </div> |
| <div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceiceberg.html">iceberg</a> {</div> |
| <div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> </div> |
| <div class="foldopen" id="foldopen00038" data-start="{" data-end="};"> |
| <div class="line"><a id="l00038" name="l00038"></a><span class="lineno"><a class="line" href="structiceberg_1_1WriteResult.html"> 38</a></span><span class="keyword">struct </span>ICEBERG_DATA_EXPORT <a class="code hl_struct" href="structiceberg_1_1WriteResult.html">WriteResult</a> {</div> |
| <div class="line"><a id="l00042" name="l00042"></a><span class="lineno"><a class="line" href="structiceberg_1_1WriteResult.html#ae97b9c03946ce35958e5a1fb8467d9e2"> 42</a></span> std::vector<std::shared_ptr<DataFile>> <a class="code hl_variable" href="structiceberg_1_1WriteResult.html#ae97b9c03946ce35958e5a1fb8467d9e2">data_files</a>;</div> |
| <div class="line"><a id="l00044" name="l00044"></a><span class="lineno"><a class="line" href="structiceberg_1_1WriteResult.html#a80f1d452ca6c3437421d13484a557a22"> 44</a></span> std::vector<std::string> <a class="code hl_variable" href="structiceberg_1_1WriteResult.html#a80f1d452ca6c3437421d13484a557a22">referenced_data_files</a>;</div> |
| <div class="line"><a id="l00046" name="l00046"></a><span class="lineno"><a class="line" href="structiceberg_1_1WriteResult.html#a7cabddd5aea546ee9211f3762980ac7c"> 46</a></span> std::vector<std::shared_ptr<DataFile>> <a class="code hl_variable" href="structiceberg_1_1WriteResult.html#a7cabddd5aea546ee9211f3762980ac7c">rewritten_delete_files</a>;</div> |
| <div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span>};</div> |
| </div> |
| <div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> </div> |
| <div class="foldopen" id="foldopen00050" data-start="{" data-end="};"> |
| <div class="line"><a id="l00050" name="l00050"></a><span class="lineno"><a class="line" href="classiceberg_1_1FileWriter.html"> 50</a></span><span class="keyword">class </span>ICEBERG_DATA_EXPORT <a class="code hl_class" href="classiceberg_1_1FileWriter.html">FileWriter</a> {</div> |
| <div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> <span class="keyword">public</span>:</div> |
| <div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> <span class="keyword">virtual</span> <a class="code hl_class" href="classiceberg_1_1FileWriter.html">~FileWriter</a>();</div> |
| <div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> </div> |
| <div class="line"><a id="l00056" name="l00056"></a><span class="lineno"><a class="line" href="classiceberg_1_1FileWriter.html#ad27902863767dbda5a2d7fcf88eb0e28"> 56</a></span> <span class="keyword">virtual</span> Status <a class="code hl_function" href="classiceberg_1_1FileWriter.html#ad27902863767dbda5a2d7fcf88eb0e28">Write</a>(<a class="code hl_struct" href="structArrowArray.html">ArrowArray</a>* data) = 0;</div> |
| <div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> </div> |
| <div class="line"><a id="l00059" name="l00059"></a><span class="lineno"><a class="line" href="classiceberg_1_1FileWriter.html#ad32f2d3323e2fea39baa59a96eb50197"> 59</a></span> <span class="keyword">virtual</span> <a class="code hl_typedef" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result<int64_t></a> <a class="code hl_function" href="classiceberg_1_1FileWriter.html#ad32f2d3323e2fea39baa59a96eb50197">Length</a>() <span class="keyword">const</span> = 0;</div> |
| <div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> </div> |
| <div class="line"><a id="l00062" name="l00062"></a><span class="lineno"><a class="line" href="classiceberg_1_1FileWriter.html#a6d7f69f445e791c2c864913fc1188370"> 62</a></span> <span class="keyword">virtual</span> Status <a class="code hl_function" href="classiceberg_1_1FileWriter.html#a6d7f69f445e791c2c864913fc1188370">Close</a>() = 0;</div> |
| <div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> </div> |
| <div class="line"><a id="l00066" name="l00066"></a><span class="lineno"><a class="line" href="classiceberg_1_1FileWriter.html#a7206abe67a08dc3362379f810cf11b96"> 66</a></span> <span class="keyword">virtual</span> <a class="code hl_typedef" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result<WriteResult></a> <a class="code hl_function" href="classiceberg_1_1FileWriter.html#a7206abe67a08dc3362379f810cf11b96">Metadata</a>() = 0;</div> |
| <div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span>};</div> |
| </div> |
| <div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> </div> |
| <div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span>} <span class="comment">// namespace iceberg</span></div> |
| <div class="ttc" id="aarrow__c__data_8h_html"><div class="ttname"><a href="arrow__c__data_8h.html">arrow_c_data.h</a></div></div> |
| <div class="ttc" id="aclassiceberg_1_1FileWriter_html"><div class="ttname"><a href="classiceberg_1_1FileWriter.html">iceberg::FileWriter</a></div><div class="ttdoc">Base interface for data file writers.</div><div class="ttdef"><b>Definition</b> writer.h:50</div></div> |
| <div class="ttc" id="aclassiceberg_1_1FileWriter_html_a6d7f69f445e791c2c864913fc1188370"><div class="ttname"><a href="classiceberg_1_1FileWriter.html#a6d7f69f445e791c2c864913fc1188370">iceberg::FileWriter::Close</a></div><div class="ttdeci">virtual Status Close()=0</div><div class="ttdoc">Close the writer and finalize the file.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1FileWriter_html_a7206abe67a08dc3362379f810cf11b96"><div class="ttname"><a href="classiceberg_1_1FileWriter.html#a7206abe67a08dc3362379f810cf11b96">iceberg::FileWriter::Metadata</a></div><div class="ttdeci">virtual Result< WriteResult > Metadata()=0</div><div class="ttdoc">Get file metadata for all files produced by this writer.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1FileWriter_html_ad27902863767dbda5a2d7fcf88eb0e28"><div class="ttname"><a href="classiceberg_1_1FileWriter.html#ad27902863767dbda5a2d7fcf88eb0e28">iceberg::FileWriter::Write</a></div><div class="ttdeci">virtual Status Write(ArrowArray *data)=0</div><div class="ttdoc">Write a batch of records.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1FileWriter_html_ad32f2d3323e2fea39baa59a96eb50197"><div class="ttname"><a href="classiceberg_1_1FileWriter.html#ad32f2d3323e2fea39baa59a96eb50197">iceberg::FileWriter::Length</a></div><div class="ttdeci">virtual Result< int64_t > Length() const =0</div><div class="ttdoc">Get the current number of bytes written.</div></div> |
| <div class="ttc" id="aiceberg__data__export_8h_html"><div class="ttname"><a href="iceberg__data__export_8h.html">iceberg_data_export.h</a></div><div class="ttdoc">Define symbol visibility macros for data APIs.</div></div> |
| <div class="ttc" id="anamespaceiceberg_html"><div class="ttname"><a href="namespaceiceberg.html">iceberg</a></div><div class="ttdoc">Core Apache Iceberg C++ APIs.</div><div class="ttdef"><b>Definition</b> arrow_io_util.h:33</div></div> |
| <div class="ttc" id="anamespaceiceberg_html_a9d5594e371beb516b0120e07e69d3af6"><div class="ttname"><a href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">iceberg::Result</a></div><div class="ttdeci">std::expected< T, E > Result</div><div class="ttdoc">Result alias.</div><div class="ttdef"><b>Definition</b> result.h:88</div></div> |
| <div class="ttc" id="aresult_8h_html"><div class="ttname"><a href="result_8h.html">result.h</a></div><div class="ttdoc">Define Result, Status, and error helpers.</div></div> |
| <div class="ttc" id="astructArrowArray_html"><div class="ttname"><a href="structArrowArray.html">ArrowArray</a></div><div class="ttdef"><b>Definition</b> arrow_c_data.h:57</div></div> |
| <div class="ttc" id="astructiceberg_1_1WriteResult_html"><div class="ttname"><a href="structiceberg_1_1WriteResult.html">iceberg::WriteResult</a></div><div class="ttdoc">File metadata for files produced by a writer.</div><div class="ttdef"><b>Definition</b> writer.h:38</div></div> |
| <div class="ttc" id="astructiceberg_1_1WriteResult_html_a7cabddd5aea546ee9211f3762980ac7c"><div class="ttname"><a href="structiceberg_1_1WriteResult.html#a7cabddd5aea546ee9211f3762980ac7c">iceberg::WriteResult::rewritten_delete_files</a></div><div class="ttdeci">std::vector< std::shared_ptr< DataFile > > rewritten_delete_files</div><div class="ttdoc">Previously written delete files that were merged and should be removed.</div><div class="ttdef"><b>Definition</b> writer.h:46</div></div> |
| <div class="ttc" id="astructiceberg_1_1WriteResult_html_a80f1d452ca6c3437421d13484a557a22"><div class="ttname"><a href="structiceberg_1_1WriteResult.html#a80f1d452ca6c3437421d13484a557a22">iceberg::WriteResult::referenced_data_files</a></div><div class="ttdeci">std::vector< std::string > referenced_data_files</div><div class="ttdoc">Data files referenced by the produced delete files.</div><div class="ttdef"><b>Definition</b> writer.h:44</div></div> |
| <div class="ttc" id="astructiceberg_1_1WriteResult_html_ae97b9c03946ce35958e5a1fb8467d9e2"><div class="ttname"><a href="structiceberg_1_1WriteResult.html#ae97b9c03946ce35958e5a1fb8467d9e2">iceberg::WriteResult::data_files</a></div><div class="ttdeci">std::vector< std::shared_ptr< DataFile > > data_files</div><div class="ttdef"><b>Definition</b> writer.h:42</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> |
