| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>RewriteStrategy</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../jquery/jquery-3.5.1.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="RewriteStrategy"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.iceberg.actions</a></div> |
| <h2 title="Interface RewriteStrategy" class="title">Interface RewriteStrategy</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><code>java.io.Serializable</code></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="BinPackStrategy.html" title="class in org.apache.iceberg.actions">BinPackStrategy</a></code>, <code><a href="SortStrategy.html" title="class in org.apache.iceberg.actions">SortStrategy</a></code>, <code><a href="../spark/actions/Spark3BinPackStrategy.html" title="class in org.apache.iceberg.spark.actions">Spark3BinPackStrategy</a></code>, <code><a href="../spark/actions/Spark3SortStrategy.html" title="class in org.apache.iceberg.spark.actions">Spark3SortStrategy</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">RewriteStrategy</span> |
| extends java.io.Serializable</pre> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#name()">name</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the name of this rewrite strategy</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="RewriteStrategy.html" title="interface in org.apache.iceberg.actions">RewriteStrategy</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#options(java.util.Map)">options</a></span>​(java.util.Map<java.lang.String,​java.lang.String> options)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets options to be used with this strategy</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>java.lang.Iterable<java.util.List<<a href="../FileScanTask.html" title="interface in org.apache.iceberg">FileScanTask</a>>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#planFileGroups(java.lang.Iterable)">planFileGroups</a></span>​(java.lang.Iterable<<a href="../FileScanTask.html" title="interface in org.apache.iceberg">FileScanTask</a>> dataFiles)</code></th> |
| <td class="colLast"> |
| <div class="block">Groups file scans into lists which will be processed in a single executable unit.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>java.util.Set<<a href="../DataFile.html" title="interface in org.apache.iceberg">DataFile</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#rewriteFiles(java.util.List)">rewriteFiles</a></span>​(java.util.List<<a href="../FileScanTask.html" title="interface in org.apache.iceberg">FileScanTask</a>> filesToRewrite)</code></th> |
| <td class="colLast"> |
| <div class="block">Method which will rewrite files based on this particular RewriteStrategy's algorithm.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>java.lang.Iterable<<a href="../FileScanTask.html" title="interface in org.apache.iceberg">FileScanTask</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#selectFilesToRewrite(java.lang.Iterable)">selectFilesToRewrite</a></span>​(java.lang.Iterable<<a href="../FileScanTask.html" title="interface in org.apache.iceberg">FileScanTask</a>> dataFiles)</code></th> |
| <td class="colLast"> |
| <div class="block">Selects files which this strategy believes are valid targets to be rewritten.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../Table.html" title="interface in org.apache.iceberg">Table</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#table()">table</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the table being modified by this rewrite strategy</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>java.util.Set<java.lang.String></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#validOptions()">validOptions</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a set of options which this rewrite strategy can use.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="name()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>name</h4> |
| <pre class="methodSignature">java.lang.String name()</pre> |
| <div class="block">Returns the name of this rewrite strategy</div> |
| </li> |
| </ul> |
| <a id="table()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>table</h4> |
| <pre class="methodSignature"><a href="../Table.html" title="interface in org.apache.iceberg">Table</a> table()</pre> |
| <div class="block">Returns the table being modified by this rewrite strategy</div> |
| </li> |
| </ul> |
| <a id="validOptions()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>validOptions</h4> |
| <pre class="methodSignature">java.util.Set<java.lang.String> validOptions()</pre> |
| <div class="block">Returns a set of options which this rewrite strategy can use. This is an allowed-list and any options not |
| specified here will be rejected at runtime.</div> |
| </li> |
| </ul> |
| <a id="options(java.util.Map)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>options</h4> |
| <pre class="methodSignature"><a href="RewriteStrategy.html" title="interface in org.apache.iceberg.actions">RewriteStrategy</a> options​(java.util.Map<java.lang.String,​java.lang.String> options)</pre> |
| <div class="block">Sets options to be used with this strategy</div> |
| </li> |
| </ul> |
| <a id="selectFilesToRewrite(java.lang.Iterable)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>selectFilesToRewrite</h4> |
| <pre class="methodSignature">java.lang.Iterable<<a href="../FileScanTask.html" title="interface in org.apache.iceberg">FileScanTask</a>> selectFilesToRewrite​(java.lang.Iterable<<a href="../FileScanTask.html" title="interface in org.apache.iceberg">FileScanTask</a>> dataFiles)</pre> |
| <div class="block">Selects files which this strategy believes are valid targets to be rewritten.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>dataFiles</code> - iterable of FileScanTasks for files in a given partition</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>iterable containing only FileScanTasks to be rewritten</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="planFileGroups(java.lang.Iterable)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>planFileGroups</h4> |
| <pre class="methodSignature">java.lang.Iterable<java.util.List<<a href="../FileScanTask.html" title="interface in org.apache.iceberg">FileScanTask</a>>> planFileGroups​(java.lang.Iterable<<a href="../FileScanTask.html" title="interface in org.apache.iceberg">FileScanTask</a>> dataFiles)</pre> |
| <div class="block">Groups file scans into lists which will be processed in a single executable unit. Each group will end up being |
| committed as an independent set of changes. This creates the jobs which will eventually be run as by the underlying |
| Action.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>dataFiles</code> - iterable of FileScanTasks to be rewritten</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>iterable of lists of FileScanTasks which will be processed together</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="rewriteFiles(java.util.List)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>rewriteFiles</h4> |
| <pre class="methodSignature">java.util.Set<<a href="../DataFile.html" title="interface in org.apache.iceberg">DataFile</a>> rewriteFiles​(java.util.List<<a href="../FileScanTask.html" title="interface in org.apache.iceberg">FileScanTask</a>> filesToRewrite)</pre> |
| <div class="block">Method which will rewrite files based on this particular RewriteStrategy's algorithm. |
| This will most likely be Action framework specific (Spark/Presto/Flink ....).</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>filesToRewrite</code> - a group of files to be rewritten together</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a set of newly written files</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| </footer> |
| </body> |
| </html> |
