| <!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/delete_files.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_6d010e03372010f41233a7d3a31e0117.html">update</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"><div class="title">delete_files.h</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="delete__files_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="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 <memory></span></div> |
| <div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#include <string></span></div> |
| <div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="preprocessor">#include <string_view></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="preprocessor">#include "<a class="code" href="iceberg__export_8h.html">iceberg/iceberg_export.h</a>"</span></div> |
| <div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="preprocessor">#include "<a class="code" href="result_8h.html">iceberg/result.h</a>"</span></div> |
| <div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</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="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="preprocessor">#include "<a class="code" href="merging__snapshot__update_8h.html">iceberg/update/merging_snapshot_update.h</a>"</span></div> |
| <div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> </div> |
| <div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceiceberg.html">iceberg</a> {</div> |
| <div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> </div> |
| <div class="foldopen" id="foldopen00044" data-start="{" data-end="};"> |
| <div class="line"><a id="l00044" name="l00044"></a><span class="lineno"><a class="line" href="classiceberg_1_1DeleteFiles.html"> 44</a></span><span class="keyword">class </span>ICEBERG_EXPORT <a class="code hl_class" href="classiceberg_1_1DeleteFiles.html">DeleteFiles</a> : <span class="keyword">public</span> <a class="code hl_class" href="classiceberg_1_1MergingSnapshotUpdate.html">MergingSnapshotUpdate</a> {</div> |
| <div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> <span class="keyword">public</span>:</div> |
| <div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> <span class="keyword">static</span> <a class="code hl_typedef" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result<std::unique_ptr<DeleteFiles></a>> Make(</div> |
| <div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> std::string table_name, std::shared_ptr<TransactionContext> ctx);</div> |
| <div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> </div> |
| <div class="line"><a id="l00053" name="l00053"></a><span class="lineno"><a class="line" href="classiceberg_1_1DeleteFiles.html#a109d1e9dadc67e62f786afa1218c2cfb"> 53</a></span> <a class="code hl_class" href="classiceberg_1_1DeleteFiles.html">DeleteFiles</a>& <a class="code hl_function" href="classiceberg_1_1DeleteFiles.html#a109d1e9dadc67e62f786afa1218c2cfb">DeleteFile</a>(std::string_view path);</div> |
| <div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> </div> |
| <div class="line"><a id="l00059" name="l00059"></a><span class="lineno"><a class="line" href="classiceberg_1_1DeleteFiles.html#ab04a10116bb91cb790d3f262ca6834fc"> 59</a></span> <a class="code hl_class" href="classiceberg_1_1DeleteFiles.html">DeleteFiles</a>& <a class="code hl_function" href="classiceberg_1_1DeleteFiles.html#ab04a10116bb91cb790d3f262ca6834fc">DeleteFile</a>(<span class="keyword">const</span> std::shared_ptr<DataFile>& file);</div> |
| <div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> </div> |
| <div class="line"><a id="l00075" name="l00075"></a><span class="lineno"><a class="line" href="classiceberg_1_1DeleteFiles.html#a5eaae33f2df81c97002333453d24f300"> 75</a></span> <a class="code hl_class" href="classiceberg_1_1DeleteFiles.html">DeleteFiles</a>& <a class="code hl_function" href="classiceberg_1_1DeleteFiles.html#a5eaae33f2df81c97002333453d24f300">DeleteFromRowFilter</a>(std::shared_ptr<Expression> expr);</div> |
| <div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> </div> |
| <div class="line"><a id="l00081" name="l00081"></a><span class="lineno"><a class="line" href="classiceberg_1_1DeleteFiles.html#a8d6e6ee4ecfa00c574b6a2933934d8a4"> 81</a></span> <a class="code hl_class" href="classiceberg_1_1DeleteFiles.html">DeleteFiles</a>& <a class="code hl_function" href="classiceberg_1_1DeleteFiles.html#a8d6e6ee4ecfa00c574b6a2933934d8a4">CaseSensitive</a>(<span class="keywordtype">bool</span> case_sensitive);</div> |
| <div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> </div> |
| <div class="line"><a id="l00089" name="l00089"></a><span class="lineno"><a class="line" href="classiceberg_1_1DeleteFiles.html#a2e11fc4c284c556a5b6b6c00ea6dd47c"> 89</a></span> <a class="code hl_class" href="classiceberg_1_1DeleteFiles.html">DeleteFiles</a>& <a class="code hl_function" href="classiceberg_1_1DeleteFiles.html#a2e11fc4c284c556a5b6b6c00ea6dd47c">ValidateFilesExist</a>();</div> |
| <div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> </div> |
| <div class="line"><a id="l00091" name="l00091"></a><span class="lineno"><a class="line" href="classiceberg_1_1DeleteFiles.html#af3e655504e861bcecaf0af74a781669e"> 91</a></span> std::string <a class="code hl_function" href="classiceberg_1_1DeleteFiles.html#af3e655504e861bcecaf0af74a781669e">operation</a>() <span class="keyword">override</span>;</div> |
| <div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> </div> |
| <div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> <span class="keyword">protected</span>:</div> |
| <div class="line"><a id="l00094" name="l00094"></a><span class="lineno"><a class="line" href="classiceberg_1_1DeleteFiles.html#afbf1480baba5762714b135142658602e"> 94</a></span> Status <a class="code hl_function" href="classiceberg_1_1DeleteFiles.html#afbf1480baba5762714b135142658602e">Validate</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structiceberg_1_1TableMetadata.html">TableMetadata</a>& current_metadata,</div> |
| <div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> <span class="keyword">const</span> std::shared_ptr<Snapshot>& snapshot) <span class="keyword">override</span>;</div> |
| <div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> </div> |
| <div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> <span class="keyword">private</span>:</div> |
| <div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> <a class="code hl_class" href="classiceberg_1_1DeleteFiles.html">DeleteFiles</a>(std::string table_name, std::shared_ptr<TransactionContext> ctx);</div> |
| <div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> </div> |
| <div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> <span class="keywordtype">bool</span> validate_files_to_delete_exist_ = <span class="keyword">false</span>;</div> |
| <div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span>};</div> |
| </div> |
| <div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span> </div> |
| <div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span>} <span class="comment">// namespace iceberg</span></div> |
| <div class="ttc" id="aclassiceberg_1_1DeleteFiles_html"><div class="ttname"><a href="classiceberg_1_1DeleteFiles.html">iceberg::DeleteFiles</a></div><div class="ttdoc">API for deleting data files from a table.</div><div class="ttdef"><b>Definition</b> delete_files.h:44</div></div> |
| <div class="ttc" id="aclassiceberg_1_1DeleteFiles_html_a109d1e9dadc67e62f786afa1218c2cfb"><div class="ttname"><a href="classiceberg_1_1DeleteFiles.html#a109d1e9dadc67e62f786afa1218c2cfb">iceberg::DeleteFiles::DeleteFile</a></div><div class="ttdeci">DeleteFiles & DeleteFile(std::string_view path)</div><div class="ttdoc">Delete a file by path from the underlying table.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1DeleteFiles_html_a2e11fc4c284c556a5b6b6c00ea6dd47c"><div class="ttname"><a href="classiceberg_1_1DeleteFiles.html#a2e11fc4c284c556a5b6b6c00ea6dd47c">iceberg::DeleteFiles::ValidateFilesExist</a></div><div class="ttdeci">DeleteFiles & ValidateFilesExist()</div><div class="ttdoc">Enable validation that deleted files still exist.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1DeleteFiles_html_a5eaae33f2df81c97002333453d24f300"><div class="ttname"><a href="classiceberg_1_1DeleteFiles.html#a5eaae33f2df81c97002333453d24f300">iceberg::DeleteFiles::DeleteFromRowFilter</a></div><div class="ttdeci">DeleteFiles & DeleteFromRowFilter(std::shared_ptr< Expression > expr)</div><div class="ttdoc">Delete files that match an expression on data rows from the table.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1DeleteFiles_html_a8d6e6ee4ecfa00c574b6a2933934d8a4"><div class="ttname"><a href="classiceberg_1_1DeleteFiles.html#a8d6e6ee4ecfa00c574b6a2933934d8a4">iceberg::DeleteFiles::CaseSensitive</a></div><div class="ttdeci">DeleteFiles & CaseSensitive(bool case_sensitive)</div><div class="ttdoc">Enable or disable case-sensitive expression binding for validations.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1DeleteFiles_html_ab04a10116bb91cb790d3f262ca6834fc"><div class="ttname"><a href="classiceberg_1_1DeleteFiles.html#ab04a10116bb91cb790d3f262ca6834fc">iceberg::DeleteFiles::DeleteFile</a></div><div class="ttdeci">DeleteFiles & DeleteFile(const std::shared_ptr< DataFile > &file)</div><div class="ttdoc">Delete a file tracked by a DataFile from the underlying table.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1DeleteFiles_html_af3e655504e861bcecaf0af74a781669e"><div class="ttname"><a href="classiceberg_1_1DeleteFiles.html#af3e655504e861bcecaf0af74a781669e">iceberg::DeleteFiles::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_1DeleteFiles_html_afbf1480baba5762714b135142658602e"><div class="ttname"><a href="classiceberg_1_1DeleteFiles.html#afbf1480baba5762714b135142658602e">iceberg::DeleteFiles::Validate</a></div><div class="ttdeci">Status Validate(const TableMetadata &current_metadata, const std::shared_ptr< Snapshot > &snapshot) override</div><div class="ttdoc">Validate the current metadata.</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< 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="astructiceberg_1_1TableMetadata_html"><div class="ttname"><a href="structiceberg_1_1TableMetadata.html">iceberg::TableMetadata</a></div><div class="ttdoc">Represents the metadata for an Iceberg table.</div><div class="ttdef"><b>Definition</b> table_metadata.h:73</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> |
