| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>Scan</title> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="Scan"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":18,"i14":6,"i15":6,"i16":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../overview-summary.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"> |
| <li><a href="../../../org/apache/iceberg/RowLevelOperationMode.html" title="enum in org.apache.iceberg"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../org/apache/iceberg/ScanSummary.html" title="class in org.apache.iceberg"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?org/apache/iceberg/Scan.html" target="_top">Frames</a></li> |
| <li><a href="Scan.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../allclasses-noframe.html">All Classes</a></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> |
| </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 name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.iceberg</div> |
| <h2 title="Interface Scan" class="title">Interface Scan<ThisT,T extends <a href="../../../org/apache/iceberg/ScanTask.html" title="interface in org.apache.iceberg">ScanTask</a>,G extends <a href="../../../org/apache/iceberg/ScanTaskGroup.html" title="interface in org.apache.iceberg">ScanTaskGroup</a><T>></h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>ThisT</code> - the child Java API class, returned by method chaining</dd> |
| <dd><code>T</code> - the Java type of tasks produces by this scan</dd> |
| <dd><code>G</code> - the Java type of task groups produces by this scan</dd> |
| </dl> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><a href="../../../org/apache/iceberg/BatchScan.html" title="interface in org.apache.iceberg">BatchScan</a>, <a href="../../../org/apache/iceberg/IncrementalAppendScan.html" title="interface in org.apache.iceberg">IncrementalAppendScan</a>, <a href="../../../org/apache/iceberg/IncrementalChangelogScan.html" title="interface in org.apache.iceberg">IncrementalChangelogScan</a>, <a href="../../../org/apache/iceberg/IncrementalScan.html" title="interface in org.apache.iceberg">IncrementalScan</a><ThisT,T,G>, <a href="../../../org/apache/iceberg/TableScan.html" title="interface in org.apache.iceberg">TableScan</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../org/apache/iceberg/AllDataFilesTable.AllDataFilesTableScan.html" title="class in org.apache.iceberg">AllDataFilesTable.AllDataFilesTableScan</a>, <a href="../../../org/apache/iceberg/AllDeleteFilesTable.AllDeleteFilesTableScan.html" title="class in org.apache.iceberg">AllDeleteFilesTable.AllDeleteFilesTableScan</a>, <a href="../../../org/apache/iceberg/AllFilesTable.AllFilesTableScan.html" title="class in org.apache.iceberg">AllFilesTable.AllFilesTableScan</a>, <a href="../../../org/apache/iceberg/AllManifestsTable.AllManifestsTableScan.html" title="class in org.apache.iceberg">AllManifestsTable.AllManifestsTableScan</a>, <a href="../../../org/apache/iceberg/DataFilesTable.DataFilesTableScan.html" title="class in org.apache.iceberg">DataFilesTable.DataFilesTableScan</a>, <a href="../../../org/apache/iceberg/DataTableScan.html" title="class in org.apache.iceberg">DataTableScan</a>, <a href="../../../org/apache/iceberg/DeleteFilesTable.DeleteFilesTableScan.html" title="class in org.apache.iceberg">DeleteFilesTable.DeleteFilesTableScan</a>, <a href="../../../org/apache/iceberg/FilesTable.FilesTableScan.html" title="class in org.apache.iceberg">FilesTable.FilesTableScan</a>, <a href="../../../org/apache/iceberg/PositionDeletesTable.PositionDeletesBatchScan.html" title="class in org.apache.iceberg">PositionDeletesTable.PositionDeletesBatchScan</a>, <a href="../../../org/apache/iceberg/SnapshotScan.html" title="class in org.apache.iceberg">SnapshotScan</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">Scan<ThisT,T extends <a href="../../../org/apache/iceberg/ScanTask.html" title="interface in org.apache.iceberg">ScanTask</a>,G extends <a href="../../../org/apache/iceberg/ScanTaskGroup.html" title="interface in org.apache.iceberg">ScanTaskGroup</a><T>></span></pre> |
| <div class="block">Scan objects are immutable and can be shared between threads. Refinement methods, like <a href="../../../org/apache/iceberg/Scan.html#select-java.util.Collection-"><code>select(Collection)</code></a> and <a href="../../../org/apache/iceberg/Scan.html#filter-org.apache.iceberg.expressions.Expression-"><code>filter(Expression)</code></a>, create new TableScan instances.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <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><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="../../../org/apache/iceberg/Scan.html" title="type parameter in Scan">ThisT</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/Scan.html#caseSensitive-boolean-">caseSensitive</a></span>(boolean caseSensitive)</code> |
| <div class="block">Create a new scan from this that, if data columns where selected via <a href="../../../org/apache/iceberg/Scan.html#select-java.util.Collection-"><code>select(java.util.Collection)</code></a>, controls whether the match to the schema will be done with case |
| sensitivity.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../org/apache/iceberg/expressions/Expression.html" title="interface in org.apache.iceberg.expressions">Expression</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/Scan.html#filter--">filter</a></span>()</code> |
| <div class="block">Returns this scan's filter <a href="../../../org/apache/iceberg/expressions/Expression.html" title="interface in org.apache.iceberg.expressions"><code>Expression</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../org/apache/iceberg/Scan.html" title="type parameter in Scan">ThisT</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/Scan.html#filter-org.apache.iceberg.expressions.Expression-">filter</a></span>(<a href="../../../org/apache/iceberg/expressions/Expression.html" title="interface in org.apache.iceberg.expressions">Expression</a> expr)</code> |
| <div class="block">Create a new scan from the results of this filtered by the <a href="../../../org/apache/iceberg/expressions/Expression.html" title="interface in org.apache.iceberg.expressions"><code>Expression</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../org/apache/iceberg/Scan.html" title="type parameter in Scan">ThisT</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/Scan.html#ignoreResiduals--">ignoreResiduals</a></span>()</code> |
| <div class="block">Create a new scan from this that applies data filtering to files but not to rows in those |
| files.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../org/apache/iceberg/Scan.html" title="type parameter in Scan">ThisT</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/Scan.html#includeColumnStats--">includeColumnStats</a></span>()</code> |
| <div class="block">Create a new scan from this that loads the column stats with each data file.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/Scan.html#isCaseSensitive--">isCaseSensitive</a></span>()</code> |
| <div class="block">Returns whether this scan is case-sensitive with respect to column names.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../org/apache/iceberg/Scan.html" title="type parameter in Scan">ThisT</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/Scan.html#option-java.lang.String-java.lang.String-">option</a></span>(java.lang.String property, |
| java.lang.String value)</code> |
| <div class="block">Create a new scan from this scan's configuration that will override the <a href="../../../org/apache/iceberg/Table.html" title="interface in org.apache.iceberg"><code>Table</code></a>'s |
| behavior based on the incoming pair.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../org/apache/iceberg/io/CloseableIterable.html" title="interface in org.apache.iceberg.io">CloseableIterable</a><<a href="../../../org/apache/iceberg/Scan.html" title="type parameter in Scan">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/Scan.html#planFiles--">planFiles</a></span>()</code> |
| <div class="block">Plan tasks for this scan where each task reads a single file.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="../../../org/apache/iceberg/io/CloseableIterable.html" title="interface in org.apache.iceberg.io">CloseableIterable</a><<a href="../../../org/apache/iceberg/Scan.html" title="type parameter in Scan">G</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/Scan.html#planTasks--">planTasks</a></span>()</code> |
| <div class="block">Plan balanced task groups for this scan by splitting large and combining small tasks.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../org/apache/iceberg/Scan.html" title="type parameter in Scan">ThisT</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/Scan.html#planWith-java.util.concurrent.ExecutorService-">planWith</a></span>(java.util.concurrent.ExecutorService executorService)</code> |
| <div class="block">Create a new scan to use a particular executor to plan.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="../../../org/apache/iceberg/Scan.html" title="type parameter in Scan">ThisT</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/Scan.html#project-org.apache.iceberg.Schema-">project</a></span>(<a href="../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg">Schema</a> schema)</code> |
| <div class="block">Create a new scan from this with the schema as its projection.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg">Schema</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/Scan.html#schema--">schema</a></span>()</code> |
| <div class="block">Returns this scan's projection <a href="../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg"><code>Schema</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="../../../org/apache/iceberg/Scan.html" title="type parameter in Scan">ThisT</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/Scan.html#select-java.util.Collection-">select</a></span>(java.util.Collection<java.lang.String> columns)</code> |
| <div class="block">Create a new scan from this that will read the given data columns.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>default <a href="../../../org/apache/iceberg/Scan.html" title="type parameter in Scan">ThisT</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/Scan.html#select-java.lang.String...-">select</a></span>(java.lang.String... columns)</code> |
| <div class="block">Create a new scan from this that will read the given columns.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/Scan.html#splitLookback--">splitLookback</a></span>()</code> |
| <div class="block">Returns the split lookback for this scan.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/Scan.html#splitOpenFileCost--">splitOpenFileCost</a></span>()</code> |
| <div class="block">Returns the split open file cost for this scan.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/Scan.html#targetSplitSize--">targetSplitSize</a></span>()</code> |
| <div class="block">Returns the target split size for this scan.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="option-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>option</h4> |
| <pre><a href="../../../org/apache/iceberg/Scan.html" title="type parameter in Scan">ThisT</a> option(java.lang.String property, |
| java.lang.String value)</pre> |
| <div class="block">Create a new scan from this scan's configuration that will override the <a href="../../../org/apache/iceberg/Table.html" title="interface in org.apache.iceberg"><code>Table</code></a>'s |
| behavior based on the incoming pair. Unknown properties will be ignored.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>property</code> - name of the table property to be overridden</dd> |
| <dd><code>value</code> - value to override with</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new scan based on this with overridden behavior</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="project-org.apache.iceberg.Schema-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>project</h4> |
| <pre><a href="../../../org/apache/iceberg/Scan.html" title="type parameter in Scan">ThisT</a> project(<a href="../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg">Schema</a> schema)</pre> |
| <div class="block">Create a new scan from this with the schema as its projection.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>schema</code> - a projection schema</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new scan based on this with the given projection</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="caseSensitive-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>caseSensitive</h4> |
| <pre><a href="../../../org/apache/iceberg/Scan.html" title="type parameter in Scan">ThisT</a> caseSensitive(boolean caseSensitive)</pre> |
| <div class="block">Create a new scan from this that, if data columns where selected via <a href="../../../org/apache/iceberg/Scan.html#select-java.util.Collection-"><code>select(java.util.Collection)</code></a>, controls whether the match to the schema will be done with case |
| sensitivity. Default is true.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new scan based on this with case sensitivity as stated</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isCaseSensitive--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isCaseSensitive</h4> |
| <pre>boolean isCaseSensitive()</pre> |
| <div class="block">Returns whether this scan is case-sensitive with respect to column names.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if case-sensitive, false otherwise.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="includeColumnStats--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>includeColumnStats</h4> |
| <pre><a href="../../../org/apache/iceberg/Scan.html" title="type parameter in Scan">ThisT</a> includeColumnStats()</pre> |
| <div class="block">Create a new scan from this that loads the column stats with each data file. |
| |
| <p>Column stats include: value count, null value count, lower bounds, and upper bounds.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new scan based on this that loads column stats.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="select-java.util.Collection-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>select</h4> |
| <pre><a href="../../../org/apache/iceberg/Scan.html" title="type parameter in Scan">ThisT</a> select(java.util.Collection<java.lang.String> columns)</pre> |
| <div class="block">Create a new scan from this that will read the given data columns. This produces an expected |
| schema that includes all fields that are either selected or used by this scan's filter |
| expression.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>columns</code> - column names from the table's schema</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new scan based on this with the given projection columns</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="select-java.lang.String...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>select</h4> |
| <pre>default <a href="../../../org/apache/iceberg/Scan.html" title="type parameter in Scan">ThisT</a> select(java.lang.String... columns)</pre> |
| <div class="block">Create a new scan from this that will read the given columns. This produces an expected schema |
| that includes all fields that are either selected or used by this scan's filter expression.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>columns</code> - column names</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new scan based on this with the given projection columns</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="filter-org.apache.iceberg.expressions.Expression-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>filter</h4> |
| <pre><a href="../../../org/apache/iceberg/Scan.html" title="type parameter in Scan">ThisT</a> filter(<a href="../../../org/apache/iceberg/expressions/Expression.html" title="interface in org.apache.iceberg.expressions">Expression</a> expr)</pre> |
| <div class="block">Create a new scan from the results of this filtered by the <a href="../../../org/apache/iceberg/expressions/Expression.html" title="interface in org.apache.iceberg.expressions"><code>Expression</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>expr</code> - a filter expression</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new scan based on this with results filtered by the expression</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="filter--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>filter</h4> |
| <pre><a href="../../../org/apache/iceberg/expressions/Expression.html" title="interface in org.apache.iceberg.expressions">Expression</a> filter()</pre> |
| <div class="block">Returns this scan's filter <a href="../../../org/apache/iceberg/expressions/Expression.html" title="interface in org.apache.iceberg.expressions"><code>Expression</code></a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this scan's filter expression</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ignoreResiduals--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ignoreResiduals</h4> |
| <pre><a href="../../../org/apache/iceberg/Scan.html" title="type parameter in Scan">ThisT</a> ignoreResiduals()</pre> |
| <div class="block">Create a new scan from this that applies data filtering to files but not to rows in those |
| files.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new scan based on this that does not filter rows in files.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="planWith-java.util.concurrent.ExecutorService-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>planWith</h4> |
| <pre><a href="../../../org/apache/iceberg/Scan.html" title="type parameter in Scan">ThisT</a> planWith(java.util.concurrent.ExecutorService executorService)</pre> |
| <div class="block">Create a new scan to use a particular executor to plan. The default worker pool will be used by |
| default.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>executorService</code> - the provided executor</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a table scan that uses the provided executor to access manifests</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="schema--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>schema</h4> |
| <pre><a href="../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg">Schema</a> schema()</pre> |
| <div class="block">Returns this scan's projection <a href="../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg"><code>Schema</code></a>. |
| |
| <p>If the projection schema was set directly using <a href="../../../org/apache/iceberg/Scan.html#project-org.apache.iceberg.Schema-"><code>project(Schema)</code></a>, returns that |
| schema. |
| |
| <p>If the projection schema was set by calling <a href="../../../org/apache/iceberg/Scan.html#select-java.util.Collection-"><code>select(Collection)</code></a>, returns a |
| projection schema that includes the selected data fields and any fields used in the filter |
| expression.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this scan's projection schema</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="planFiles--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>planFiles</h4> |
| <pre><a href="../../../org/apache/iceberg/io/CloseableIterable.html" title="interface in org.apache.iceberg.io">CloseableIterable</a><<a href="../../../org/apache/iceberg/Scan.html" title="type parameter in Scan">T</a>> planFiles()</pre> |
| <div class="block">Plan tasks for this scan where each task reads a single file. |
| |
| <p>Use <a href="../../../org/apache/iceberg/Scan.html#planTasks--"><code>planTasks()</code></a> for planning balanced tasks where each task will read either a |
| single file, a part of a file, or multiple files.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an Iterable of tasks scanning entire files required by this scan</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="planTasks--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>planTasks</h4> |
| <pre><a href="../../../org/apache/iceberg/io/CloseableIterable.html" title="interface in org.apache.iceberg.io">CloseableIterable</a><<a href="../../../org/apache/iceberg/Scan.html" title="type parameter in Scan">G</a>> planTasks()</pre> |
| <div class="block">Plan balanced task groups for this scan by splitting large and combining small tasks. |
| |
| <p>Task groups created by this method may read partial input files, multiple input files or |
| both.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an Iterable of balanced task groups required by this scan</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="targetSplitSize--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>targetSplitSize</h4> |
| <pre>long targetSplitSize()</pre> |
| <div class="block">Returns the target split size for this scan.</div> |
| </li> |
| </ul> |
| <a name="splitLookback--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>splitLookback</h4> |
| <pre>int splitLookback()</pre> |
| <div class="block">Returns the split lookback for this scan.</div> |
| </li> |
| </ul> |
| <a name="splitOpenFileCost--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>splitOpenFileCost</h4> |
| <pre>long splitOpenFileCost()</pre> |
| <div class="block">Returns the split open file cost for this scan.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../overview-summary.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"> |
| <li><a href="../../../org/apache/iceberg/RowLevelOperationMode.html" title="enum in org.apache.iceberg"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../org/apache/iceberg/ScanSummary.html" title="class in org.apache.iceberg"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?org/apache/iceberg/Scan.html" target="_top">Frames</a></li> |
| <li><a href="Scan.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../allclasses-noframe.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> |
| </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 name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
