| <!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::ManifestMergeManager Class Reference</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> |
| <!-- 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"><b>iceberg</b></li><li class="navelem"><a class="el" href="classiceberg_1_1ManifestMergeManager.html">ManifestMergeManager</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="classiceberg_1_1ManifestMergeManager-members.html">List of all members</a> </div> |
| <div class="headertitle"><div class="title">iceberg::ManifestMergeManager Class Reference</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Merges small manifests into larger ones using greedy bin-packing. |
| <a href="classiceberg_1_1ManifestMergeManager.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="manifest__merge__manager_8h_source.html">manifest_merge_manager.h</a>></code></p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:a57f9f370ec6637dd378f4c18d7ff0f76" id="r_a57f9f370ec6637dd378f4c18d7ff0f76"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1ManifestMergeManager.html#a57f9f370ec6637dd378f4c18d7ff0f76">ManifestMergeManager</a> (int64_t target_size_bytes, int32_t min_count_to_merge, bool merge_enabled)</td></tr> |
| <tr class="memdesc:a57f9f370ec6637dd378f4c18d7ff0f76"><td class="mdescLeft"> </td><td class="mdescRight">Construct a merge manager with the given configuration. <br /></td></tr> |
| <tr class="separator:a57f9f370ec6637dd378f4c18d7ff0f76"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a48fd9f3a16df724b1f0ef2f7ffe43ea3" id="r_a48fd9f3a16df724b1f0ef2f7ffe43ea3"><td class="memItemLeft" align="right" valign="top"><a id="a48fd9f3a16df724b1f0ef2f7ffe43ea3" name="a48fd9f3a16df724b1f0ef2f7ffe43ea3"></a> |
|  </td><td class="memItemRight" valign="bottom"><b>ManifestMergeManager</b> (const <a class="el" href="classiceberg_1_1ManifestMergeManager.html">ManifestMergeManager</a> &)=delete</td></tr> |
| <tr class="separator:a48fd9f3a16df724b1f0ef2f7ffe43ea3"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aff044321809cec4a7c7a2426a102c735" id="r_aff044321809cec4a7c7a2426a102c735"><td class="memItemLeft" align="right" valign="top"><a id="aff044321809cec4a7c7a2426a102c735" name="aff044321809cec4a7c7a2426a102c735"></a> |
| <a class="el" href="classiceberg_1_1ManifestMergeManager.html">ManifestMergeManager</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classiceberg_1_1ManifestMergeManager.html">ManifestMergeManager</a> &)=delete</td></tr> |
| <tr class="separator:aff044321809cec4a7c7a2426a102c735"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2ec764940fd557109ac9dc77e44b7742" id="r_a2ec764940fd557109ac9dc77e44b7742"><td class="memItemLeft" align="right" valign="top">Result< std::vector< <a class="el" href="structiceberg_1_1ManifestFile.html">ManifestFile</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1ManifestMergeManager.html#a2ec764940fd557109ac9dc77e44b7742">MergeManifests</a> (const std::vector< <a class="el" href="structiceberg_1_1ManifestFile.html">ManifestFile</a> > &existing_manifests, const std::vector< <a class="el" href="structiceberg_1_1ManifestFile.html">ManifestFile</a> > &new_manifests, int64_t snapshot_id, const <a class="el" href="structiceberg_1_1TableMetadata.html">TableMetadata</a> &metadata, std::shared_ptr< <a class="el" href="classiceberg_1_1FileIO.html">FileIO</a> > file_io, const <a class="el" href="manifest__writer_8h.html#a0fcb4cda5197f4d8c18772a445455cc2">ManifestWriterFactory</a> &writer_factory)</td></tr> |
| <tr class="memdesc:a2ec764940fd557109ac9dc77e44b7742"><td class="mdescLeft"> </td><td class="mdescRight">Merge existing and new manifests according to configured thresholds. <br /></td></tr> |
| <tr class="separator:a2ec764940fd557109ac9dc77e44b7742"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Merges small manifests into larger ones using greedy bin-packing. </p> |
| <p>Manifests are grouped by partition_spec_id before merging; manifests with different spec IDs are never merged together. Within a group, manifests are accumulated into bins until a bin would exceed target_size_bytes, at which point the bin is flushed (written) and a new one started. Manifests already larger than target_size_bytes pass through unchanged.</p> |
| <dl class="section note"><dt>Note</dt><dd>This class is non-copyable and non-movable. </dd></dl> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="a57f9f370ec6637dd378f4c18d7ff0f76" name="a57f9f370ec6637dd378f4c18d7ff0f76"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a57f9f370ec6637dd378f4c18d7ff0f76">◆ </a></span>ManifestMergeManager()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">iceberg::ManifestMergeManager::ManifestMergeManager </td> |
| <td>(</td> |
| <td class="paramtype">int64_t </td> |
| <td class="paramname"><em>target_size_bytes</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int32_t </td> |
| <td class="paramname"><em>min_count_to_merge</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>merge_enabled</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Construct a merge manager with the given configuration. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">target_size_bytes</td><td>Target output manifest size in bytes </td></tr> |
| <tr><td class="paramname">min_count_to_merge</td><td>Minimum number of manifests before any merging occurs </td></tr> |
| <tr><td class="paramname">merge_enabled</td><td>Whether merging is enabled at all </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a2ec764940fd557109ac9dc77e44b7742" name="a2ec764940fd557109ac9dc77e44b7742"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a2ec764940fd557109ac9dc77e44b7742">◆ </a></span>MergeManifests()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Result< std::vector< <a class="el" href="structiceberg_1_1ManifestFile.html">ManifestFile</a> > > iceberg::ManifestMergeManager::MergeManifests </td> |
| <td>(</td> |
| <td class="paramtype">const std::vector< <a class="el" href="structiceberg_1_1ManifestFile.html">ManifestFile</a> > & </td> |
| <td class="paramname"><em>existing_manifests</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const std::vector< <a class="el" href="structiceberg_1_1ManifestFile.html">ManifestFile</a> > & </td> |
| <td class="paramname"><em>new_manifests</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int64_t </td> |
| <td class="paramname"><em>snapshot_id</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const <a class="el" href="structiceberg_1_1TableMetadata.html">TableMetadata</a> & </td> |
| <td class="paramname"><em>metadata</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">std::shared_ptr< <a class="el" href="classiceberg_1_1FileIO.html">FileIO</a> > </td> |
| <td class="paramname"><em>file_io</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const <a class="el" href="manifest__writer_8h.html#a0fcb4cda5197f4d8c18772a445455cc2">ManifestWriterFactory</a> & </td> |
| <td class="paramname"><em>writer_factory</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Merge existing and new manifests according to configured thresholds. </p> |
| <p>Manifests are grouped by (partition_spec_id, content) — data and delete manifests are never merged together. Within each group, a greedy bin-packing algorithm combines manifests up to target_size_bytes. The bin that contains the newest manifest for that content type is protected by min_count_to_merge: if it has fewer than that many items it is passed through unchanged.</p> |
| <dl class="section note"><dt>Note</dt><dd>Retry and rollback cleanup are handled by the caller that owns created manifest paths. TODO(Guotao): Add explicit replaced-manifest tracking here if callers need direct access.</dd></dl> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">existing_manifests</td><td>Manifests already in the base snapshot </td></tr> |
| <tr><td class="paramname">new_manifests</td><td>Newly written manifests to incorporate </td></tr> |
| <tr><td class="paramname">snapshot_id</td><td>The ID of the snapshot being committed. Used to preserve ADDED/DELETED status for entries written by this snapshot and to suppress stale DELETED tombstones from prior snapshots. </td></tr> |
| <tr><td class="paramname">metadata</td><td><a class="el" href="classiceberg_1_1Table.html" title="Represents an Iceberg table.">Table</a> metadata (provides specs and schema for readers) </td></tr> |
| <tr><td class="paramname">file_io</td><td>File IO used to open existing manifests for reading </td></tr> |
| <tr><td class="paramname">writer_factory</td><td>Factory to create new <a class="el" href="classiceberg_1_1ManifestWriter.html" title="Write manifest entries to a manifest file.">ManifestWriter</a> instances </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>The merged manifest list, or an error </dd></dl> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following files:<ul> |
| <li>iceberg/manifest/<a class="el" href="manifest__merge__manager_8h_source.html">manifest_merge_manager.h</a></li> |
| <li>iceberg/manifest/<b>manifest_merge_manager.cc</b></li> |
| </ul> |
| </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> |
