blob: 547dc927c754c23264683a5aceadcbfa9b802163 [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>iceberg-cpp: iceberg/update/merge_append.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&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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;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_6d010e03372010f41233a7d3a31e0117.html">update</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">merge_append.h</div></div>
</div><!--header-->
<div class="contents">
<a href="merge__append_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"> * &quot;License&quot;); 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"> * &quot;AS IS&quot; 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="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 &lt;memory&gt;</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="preprocessor">#include &quot;<a class="code" href="iceberg__export_8h.html">iceberg/iceberg_export.h</a>&quot;</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="preprocessor">#include &quot;<a class="code" href="result_8h.html">iceberg/result.h</a>&quot;</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="preprocessor">#include &quot;<a class="code" href="type__fwd_8h.html">iceberg/type_fwd.h</a>&quot;</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="preprocessor">#include &quot;<a class="code" href="merging__snapshot__update_8h.html">iceberg/update/merging_snapshot_update.h</a>&quot;</span></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="namespaceiceberg.html">iceberg</a> {</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> </div>
<div class="foldopen" id="foldopen00043" data-start="{" data-end="};">
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"><a class="line" href="classiceberg_1_1MergeAppend.html"> 43</a></span><span class="keyword">class </span>ICEBERG_EXPORT <a class="code hl_class" href="classiceberg_1_1MergeAppend.html">MergeAppend</a> : <span class="keyword">public</span> <a class="code hl_class" href="classiceberg_1_1MergingSnapshotUpdate.html">MergingSnapshotUpdate</a> {</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"><a class="line" href="classiceberg_1_1MergeAppend.html#a9e0e9497285e1bcb442ddb0766f893fd"> 50</a></span> <span class="keyword">static</span> <a class="code hl_typedef" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result&lt;std::unique_ptr&lt;MergeAppend&gt;</a>&gt; <a class="code hl_function" href="classiceberg_1_1MergeAppend.html#a9e0e9497285e1bcb442ddb0766f893fd">Make</a>(</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> std::string table_name, std::shared_ptr&lt;TransactionContext&gt; ctx);</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> </div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"><a class="line" href="classiceberg_1_1MergeAppend.html#a57e55d30ec5d68bd7cc2578cf27f335e"> 57</a></span> <a class="code hl_class" href="classiceberg_1_1MergeAppend.html">MergeAppend</a>&amp; <a class="code hl_function" href="classiceberg_1_1MergeAppend.html#a57e55d30ec5d68bd7cc2578cf27f335e">AppendFile</a>(<span class="keyword">const</span> std::shared_ptr&lt;DataFile&gt;&amp; file);</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> </div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"><a class="line" href="classiceberg_1_1MergeAppend.html#aad75e88c3bb41bbe3dc01deb39d0a0ff"> 67</a></span> <a class="code hl_class" href="classiceberg_1_1MergeAppend.html">MergeAppend</a>&amp; <a class="code hl_function" href="classiceberg_1_1MergeAppend.html#aad75e88c3bb41bbe3dc01deb39d0a0ff">AppendManifest</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structiceberg_1_1ManifestFile.html">ManifestFile</a>&amp; manifest);</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"><a class="line" href="classiceberg_1_1MergeAppend.html#aec72ac30c75a5aa0fe923468a87908f0"> 69</a></span> std::string <a class="code hl_function" href="classiceberg_1_1MergeAppend.html#aec72ac30c75a5aa0fe923468a87908f0">operation</a>() <span class="keyword">override</span>;</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> </div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> <span class="keyword">private</span>:</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> <span class="keyword">explicit</span> <a class="code hl_class" href="classiceberg_1_1MergeAppend.html">MergeAppend</a>(std::string table_name, std::shared_ptr&lt;TransactionContext&gt; ctx);</div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span>};</div>
</div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> </div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span>} <span class="comment">// namespace iceberg</span></div>
<div class="ttc" id="aclassiceberg_1_1MergeAppend_html"><div class="ttname"><a href="classiceberg_1_1MergeAppend.html">iceberg::MergeAppend</a></div><div class="ttdoc">API for appending new files in a table while merging manifests.</div><div class="ttdef"><b>Definition</b> merge_append.h:43</div></div>
<div class="ttc" id="aclassiceberg_1_1MergeAppend_html_a57e55d30ec5d68bd7cc2578cf27f335e"><div class="ttname"><a href="classiceberg_1_1MergeAppend.html#a57e55d30ec5d68bd7cc2578cf27f335e">iceberg::MergeAppend::AppendFile</a></div><div class="ttdeci">MergeAppend &amp; AppendFile(const std::shared_ptr&lt; DataFile &gt; &amp;file)</div><div class="ttdoc">Append a DataFile to the table.</div></div>
<div class="ttc" id="aclassiceberg_1_1MergeAppend_html_a9e0e9497285e1bcb442ddb0766f893fd"><div class="ttname"><a href="classiceberg_1_1MergeAppend.html#a9e0e9497285e1bcb442ddb0766f893fd">iceberg::MergeAppend::Make</a></div><div class="ttdeci">static Result&lt; std::unique_ptr&lt; MergeAppend &gt; &gt; Make(std::string table_name, std::shared_ptr&lt; TransactionContext &gt; ctx)</div><div class="ttdoc">Create a new MergeAppend instance.</div></div>
<div class="ttc" id="aclassiceberg_1_1MergeAppend_html_aad75e88c3bb41bbe3dc01deb39d0a0ff"><div class="ttname"><a href="classiceberg_1_1MergeAppend.html#aad75e88c3bb41bbe3dc01deb39d0a0ff">iceberg::MergeAppend::AppendManifest</a></div><div class="ttdeci">MergeAppend &amp; AppendManifest(const ManifestFile &amp;manifest)</div><div class="ttdoc">Append a ManifestFile to the table.</div></div>
<div class="ttc" id="aclassiceberg_1_1MergeAppend_html_aec72ac30c75a5aa0fe923468a87908f0"><div class="ttname"><a href="classiceberg_1_1MergeAppend.html#aec72ac30c75a5aa0fe923468a87908f0">iceberg::MergeAppend::operation</a></div><div class="ttdeci">std::string operation() override</div><div class="ttdoc">A string that describes the action that produced the new snapshot.</div></div>
<div class="ttc" id="aclassiceberg_1_1MergingSnapshotUpdate_html"><div class="ttname"><a href="classiceberg_1_1MergingSnapshotUpdate.html">iceberg::MergingSnapshotUpdate</a></div><div class="ttdoc">Abstract base class for merge-based snapshot write operations.</div><div class="ttdef"><b>Definition</b> merging_snapshot_update.h:63</div></div>
<div class="ttc" id="aiceberg__export_8h_html"><div class="ttname"><a href="iceberg__export_8h.html">iceberg_export.h</a></div><div class="ttdoc">Define symbol visibility macros for core Iceberg APIs.</div></div>
<div class="ttc" id="amerging__snapshot__update_8h_html"><div class="ttname"><a href="merging__snapshot__update_8h.html">merging_snapshot_update.h</a></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&lt; T, E &gt; 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="astructiceberg_1_1ManifestFile_html"><div class="ttname"><a href="structiceberg_1_1ManifestFile.html">iceberg::ManifestFile</a></div><div class="ttdoc">Entry in a manifest list.</div><div class="ttdef"><b>Definition</b> manifest_list.h:85</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&#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>