blob: f76bbb52c4a387694b3bfa335a6447a3e17ccc97 [file] [log] [blame]
<!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>DataTableScan</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="DataTableScan";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":42,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated 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/DataOperations.html" title="class in org.apache.iceberg"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../org/apache/iceberg/DataTask.html" title="interface in org.apache.iceberg"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/apache/iceberg/DataTableScan.html" target="_top">Frames</a></li>
<li><a href="DataTableScan.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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="Class DataTableScan" class="title">Class DataTableScan</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.iceberg.DataTableScan</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../org/apache/iceberg/Scan.html" title="interface in org.apache.iceberg">Scan</a>&lt;<a href="../../../org/apache/iceberg/TableScan.html" title="interface in org.apache.iceberg">TableScan</a>,<a href="../../../org/apache/iceberg/FileScanTask.html" title="interface in org.apache.iceberg">FileScanTask</a>,<a href="../../../org/apache/iceberg/CombinedScanTask.html" title="interface in org.apache.iceberg">CombinedScanTask</a>&gt;, <a href="../../../org/apache/iceberg/TableScan.html" title="interface in org.apache.iceberg">TableScan</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">DataTableScan</span>
extends java.lang.Object</pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colLast" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/DataTableScan.html#DataTableScan-org.apache.iceberg.TableOperations-org.apache.iceberg.Table-">DataTableScan</a></span>(<a href="../../../org/apache/iceberg/TableOperations.html" title="interface in org.apache.iceberg">TableOperations</a>&nbsp;ops,
<a href="../../../org/apache/iceberg/Table.html" title="interface in org.apache.iceberg">Table</a>&nbsp;table)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/DataTableScan.html#DataTableScan-org.apache.iceberg.TableOperations-org.apache.iceberg.Table-org.apache.iceberg.Schema-org.apache.iceberg.TableScanContext-">DataTableScan</a></span>(<a href="../../../org/apache/iceberg/TableOperations.html" title="interface in org.apache.iceberg">TableOperations</a>&nbsp;ops,
<a href="../../../org/apache/iceberg/Table.html" title="interface in org.apache.iceberg">Table</a>&nbsp;table,
<a href="../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg">Schema</a>&nbsp;schema,
org.apache.iceberg.TableScanContext&nbsp;context)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== 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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</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/TableScan.html" title="interface in org.apache.iceberg">TableScan</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/DataTableScan.html#appendsAfter-long-">appendsAfter</a></span>(long&nbsp;fromSnapshotId)</code>
<div class="block">Create a new <a href="../../../org/apache/iceberg/TableScan.html" title="interface in org.apache.iceberg"><code>TableScan</code></a> to read appended data from <code>fromSnapshotId</code> exclusive to
the current snapshot inclusive.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../org/apache/iceberg/TableScan.html" title="interface in org.apache.iceberg">TableScan</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/DataTableScan.html#appendsBetween-long-long-">appendsBetween</a></span>(long&nbsp;fromSnapshotId,
long&nbsp;toSnapshotId)</code>
<div class="block">Create a new <a href="../../../org/apache/iceberg/TableScan.html" title="interface in org.apache.iceberg"><code>TableScan</code></a> to read appended data from <code>fromSnapshotId</code> exclusive to
<code>toSnapshotId</code> inclusive.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../org/apache/iceberg/TableScan.html" title="interface in org.apache.iceberg">TableScan</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/DataTableScan.html#asOfTime-long-">asOfTime</a></span>(long&nbsp;timestampMillis)</code>
<div class="block">Create a new <a href="../../../org/apache/iceberg/TableScan.html" title="interface in org.apache.iceberg"><code>TableScan</code></a> from this scan's configuration that will use the most recent
snapshot as of the given time in milliseconds on the branch in the scan or main if no branch is
set.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>ThisT</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/DataTableScan.html#caseSensitive-boolean-">caseSensitive</a></span>(boolean&nbsp;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>Scan.select(java.util.Collection)</code></a>, controls whether the match to the schema will be done with case
sensitivity.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/DataTableScan.html#colStats--">colStats</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">Will be removed in 1.2.0, use <code>TableScanContext.returnColumnStats()</code>
directly.</span></div>
</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>protected org.apache.iceberg.TableScanContext</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/DataTableScan.html#context--">context</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../org/apache/iceberg/io/CloseableIterable.html" title="interface in org.apache.iceberg.io">CloseableIterable</a>&lt;<a href="../../../org/apache/iceberg/FileScanTask.html" title="interface in org.apache.iceberg">FileScanTask</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/DataTableScan.html#doPlanFiles--">doPlanFiles</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i7" 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/DataTableScan.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="i8" class="altColor">
<td class="colFirst"><code>ThisT</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/DataTableScan.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>&nbsp;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="i9" class="rowColor">
<td class="colFirst"><code>ThisT</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/DataTableScan.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="i10" class="altColor">
<td class="colFirst"><code>ThisT</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/DataTableScan.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="i11" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/DataTableScan.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="i12" class="altColor">
<td class="colFirst"><code>protected <a href="../../../org/apache/iceberg/TableScan.html" title="interface in org.apache.iceberg">TableScan</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/DataTableScan.html#newRefinedScan-org.apache.iceberg.TableOperations-org.apache.iceberg.Table-org.apache.iceberg.Schema-org.apache.iceberg.TableScanContext-">newRefinedScan</a></span>(<a href="../../../org/apache/iceberg/TableOperations.html" title="interface in org.apache.iceberg">TableOperations</a>&nbsp;ops,
<a href="../../../org/apache/iceberg/Table.html" title="interface in org.apache.iceberg">Table</a>&nbsp;table,
<a href="../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg">Schema</a>&nbsp;schema,
org.apache.iceberg.TableScanContext&nbsp;context)</code>&nbsp;</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>ThisT</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/DataTableScan.html#option-java.lang.String-java.lang.String-">option</a></span>(java.lang.String&nbsp;property,
java.lang.String&nbsp;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="i14" class="altColor">
<td class="colFirst"><code>protected java.util.Map&lt;java.lang.String,java.lang.String&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/DataTableScan.html#options--">options</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>protected java.util.concurrent.ExecutorService</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/DataTableScan.html#planExecutor--">planExecutor</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code><a href="../../../org/apache/iceberg/io/CloseableIterable.html" title="interface in org.apache.iceberg.io">CloseableIterable</a>&lt;<a href="../../../org/apache/iceberg/FileScanTask.html" title="interface in org.apache.iceberg">FileScanTask</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/DataTableScan.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="i17" class="rowColor">
<td class="colFirst"><code><a href="../../../org/apache/iceberg/io/CloseableIterable.html" title="interface in org.apache.iceberg.io">CloseableIterable</a>&lt;<a href="../../../org/apache/iceberg/CombinedScanTask.html" title="interface in org.apache.iceberg">CombinedScanTask</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/DataTableScan.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="i18" class="altColor">
<td class="colFirst"><code>ThisT</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/DataTableScan.html#planWith-java.util.concurrent.ExecutorService-">planWith</a></span>(java.util.concurrent.ExecutorService&nbsp;executorService)</code>
<div class="block">Create a new scan to use a particular executor to plan.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>ThisT</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/DataTableScan.html#project-org.apache.iceberg.Schema-">project</a></span>(<a href="../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg">Schema</a>&nbsp;projectedSchema)</code>
<div class="block">Create a new scan from this with the schema as its projection.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>protected java.util.List&lt;java.lang.String&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/DataTableScan.html#scanColumns--">scanColumns</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>protected <a href="../../../org/apache/iceberg/metrics/ScanMetrics.html" title="class in org.apache.iceberg.metrics">ScanMetrics</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/DataTableScan.html#scanMetrics--">scanMetrics</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i22" class="altColor">
<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/DataTableScan.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="i23" class="rowColor">
<td class="colFirst"><code>ThisT</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/DataTableScan.html#select-java.util.Collection-">select</a></span>(java.util.Collection&lt;java.lang.String&gt;&nbsp;columns)</code>
<div class="block">Create a new scan from this that will read the given data columns.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/DataTableScan.html#shouldIgnoreResiduals--">shouldIgnoreResiduals</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/DataTableScan.html#shouldPlanWithExecutor--">shouldPlanWithExecutor</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code><a href="../../../org/apache/iceberg/Snapshot.html" title="interface in org.apache.iceberg">Snapshot</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/DataTableScan.html#snapshot--">snapshot</a></span>()</code>
<div class="block">Returns the <a href="../../../org/apache/iceberg/Snapshot.html" title="interface in org.apache.iceberg"><code>Snapshot</code></a> that will be used by this scan.</div>
</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code>protected java.lang.Long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/DataTableScan.html#snapshotId--">snapshotId</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/DataTableScan.html#splitLookback--">splitLookback</a></span>()</code>
<div class="block">Returns the split lookback for this scan.</div>
</td>
</tr>
<tr id="i29" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/DataTableScan.html#splitOpenFileCost--">splitOpenFileCost</a></span>()</code>
<div class="block">Returns the split open file cost for this scan.</div>
</td>
</tr>
<tr id="i30" class="altColor">
<td class="colFirst"><code><a href="../../../org/apache/iceberg/Table.html" title="interface in org.apache.iceberg">Table</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/DataTableScan.html#table--">table</a></span>()</code>
<div class="block">Returns the <a href="../../../org/apache/iceberg/Table.html" title="interface in org.apache.iceberg"><code>Table</code></a> from which this scan loads data.</div>
</td>
</tr>
<tr id="i31" class="rowColor">
<td class="colFirst"><code>protected <a href="../../../org/apache/iceberg/TableOperations.html" title="interface in org.apache.iceberg">TableOperations</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/DataTableScan.html#tableOps--">tableOps</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i32" class="altColor">
<td class="colFirst"><code>protected <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/DataTableScan.html#tableSchema--">tableSchema</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i33" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/DataTableScan.html#targetSplitSize--">targetSplitSize</a></span>()</code>
<div class="block">Returns the target split size for this scan.</div>
</td>
</tr>
<tr id="i34" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/DataTableScan.html#toString--">toString</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i35" class="rowColor">
<td class="colFirst"><code><a href="../../../org/apache/iceberg/TableScan.html" title="interface in org.apache.iceberg">TableScan</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/DataTableScan.html#useRef-java.lang.String-">useRef</a></span>(java.lang.String&nbsp;name)</code>
<div class="block">Create a new <a href="../../../org/apache/iceberg/TableScan.html" title="interface in org.apache.iceberg"><code>TableScan</code></a> from this scan's configuration that will use the given
reference.</div>
</td>
</tr>
<tr id="i36" class="altColor">
<td class="colFirst"><code><a href="../../../org/apache/iceberg/TableScan.html" title="interface in org.apache.iceberg">TableScan</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/DataTableScan.html#useSnapshot-long-">useSnapshot</a></span>(long&nbsp;scanSnapshotId)</code>
<div class="block">Create a new <a href="../../../org/apache/iceberg/TableScan.html" title="interface in org.apache.iceberg"><code>TableScan</code></a> from this scan's configuration that will use the given snapshot
by ID.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.iceberg.Scan">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.iceberg.<a href="../../../org/apache/iceberg/Scan.html" title="interface in org.apache.iceberg">Scan</a></h3>
<code><a href="../../../org/apache/iceberg/Scan.html#caseSensitive-boolean-">caseSensitive</a>, <a href="../../../org/apache/iceberg/Scan.html#filter--">filter</a>, <a href="../../../org/apache/iceberg/Scan.html#filter-org.apache.iceberg.expressions.Expression-">filter</a>, <a href="../../../org/apache/iceberg/Scan.html#ignoreResiduals--">ignoreResiduals</a>, <a href="../../../org/apache/iceberg/Scan.html#includeColumnStats--">includeColumnStats</a>, <a href="../../../org/apache/iceberg/Scan.html#isCaseSensitive--">isCaseSensitive</a>, <a href="../../../org/apache/iceberg/Scan.html#option-java.lang.String-java.lang.String-">option</a>, <a href="../../../org/apache/iceberg/Scan.html#planWith-java.util.concurrent.ExecutorService-">planWith</a>, <a href="../../../org/apache/iceberg/Scan.html#project-org.apache.iceberg.Schema-">project</a>, <a href="../../../org/apache/iceberg/Scan.html#schema--">schema</a>, <a href="../../../org/apache/iceberg/Scan.html#select-java.util.Collection-">select</a>, <a href="../../../org/apache/iceberg/Scan.html#select-java.lang.String...-">select</a>, <a href="../../../org/apache/iceberg/Scan.html#splitLookback--">splitLookback</a>, <a href="../../../org/apache/iceberg/Scan.html#splitOpenFileCost--">splitOpenFileCost</a>, <a href="../../../org/apache/iceberg/Scan.html#targetSplitSize--">targetSplitSize</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="DataTableScan-org.apache.iceberg.TableOperations-org.apache.iceberg.Table-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DataTableScan</h4>
<pre>public&nbsp;DataTableScan(<a href="../../../org/apache/iceberg/TableOperations.html" title="interface in org.apache.iceberg">TableOperations</a>&nbsp;ops,
<a href="../../../org/apache/iceberg/Table.html" title="interface in org.apache.iceberg">Table</a>&nbsp;table)</pre>
</li>
</ul>
<a name="DataTableScan-org.apache.iceberg.TableOperations-org.apache.iceberg.Table-org.apache.iceberg.Schema-org.apache.iceberg.TableScanContext-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DataTableScan</h4>
<pre>protected&nbsp;DataTableScan(<a href="../../../org/apache/iceberg/TableOperations.html" title="interface in org.apache.iceberg">TableOperations</a>&nbsp;ops,
<a href="../../../org/apache/iceberg/Table.html" title="interface in org.apache.iceberg">Table</a>&nbsp;table,
<a href="../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg">Schema</a>&nbsp;schema,
org.apache.iceberg.TableScanContext&nbsp;context)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="appendsBetween-long-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>appendsBetween</h4>
<pre>public&nbsp;<a href="../../../org/apache/iceberg/TableScan.html" title="interface in org.apache.iceberg">TableScan</a>&nbsp;appendsBetween(long&nbsp;fromSnapshotId,
long&nbsp;toSnapshotId)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../org/apache/iceberg/TableScan.html#appendsBetween-long-long-">TableScan</a></code></span></div>
<div class="block">Create a new <a href="../../../org/apache/iceberg/TableScan.html" title="interface in org.apache.iceberg"><code>TableScan</code></a> to read appended data from <code>fromSnapshotId</code> exclusive to
<code>toSnapshotId</code> inclusive.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../org/apache/iceberg/TableScan.html#appendsBetween-long-long-">appendsBetween</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/apache/iceberg/TableScan.html" title="interface in org.apache.iceberg">TableScan</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fromSnapshotId</code> - the last snapshot id read by the user, exclusive</dd>
<dd><code>toSnapshotId</code> - read append data up to this snapshot id</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a table scan which can read append data from <code>fromSnapshotId</code> exclusive and up to
<code>toSnapshotId</code> inclusive</dd>
</dl>
</li>
</ul>
<a name="appendsAfter-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>appendsAfter</h4>
<pre>public&nbsp;<a href="../../../org/apache/iceberg/TableScan.html" title="interface in org.apache.iceberg">TableScan</a>&nbsp;appendsAfter(long&nbsp;fromSnapshotId)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../org/apache/iceberg/TableScan.html#appendsAfter-long-">TableScan</a></code></span></div>
<div class="block">Create a new <a href="../../../org/apache/iceberg/TableScan.html" title="interface in org.apache.iceberg"><code>TableScan</code></a> to read appended data from <code>fromSnapshotId</code> exclusive to
the current snapshot inclusive.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../org/apache/iceberg/TableScan.html#appendsAfter-long-">appendsAfter</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/apache/iceberg/TableScan.html" title="interface in org.apache.iceberg">TableScan</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fromSnapshotId</code> - - the last snapshot id read by the user, exclusive</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a table scan which can read append data from <code>fromSnapshotId</code> exclusive and up to
current snapshot inclusive</dd>
</dl>
</li>
</ul>
<a name="useSnapshot-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>useSnapshot</h4>
<pre>public&nbsp;<a href="../../../org/apache/iceberg/TableScan.html" title="interface in org.apache.iceberg">TableScan</a>&nbsp;useSnapshot(long&nbsp;scanSnapshotId)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../org/apache/iceberg/TableScan.html#useSnapshot-long-">TableScan</a></code></span></div>
<div class="block">Create a new <a href="../../../org/apache/iceberg/TableScan.html" title="interface in org.apache.iceberg"><code>TableScan</code></a> from this scan's configuration that will use the given snapshot
by ID.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../org/apache/iceberg/TableScan.html#useSnapshot-long-">useSnapshot</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/apache/iceberg/TableScan.html" title="interface in org.apache.iceberg">TableScan</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>scanSnapshotId</code> - a snapshot ID</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a new scan based on this with the given snapshot ID</dd>
</dl>
</li>
</ul>
<a name="newRefinedScan-org.apache.iceberg.TableOperations-org.apache.iceberg.Table-org.apache.iceberg.Schema-org.apache.iceberg.TableScanContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newRefinedScan</h4>
<pre>protected&nbsp;<a href="../../../org/apache/iceberg/TableScan.html" title="interface in org.apache.iceberg">TableScan</a>&nbsp;newRefinedScan(<a href="../../../org/apache/iceberg/TableOperations.html" title="interface in org.apache.iceberg">TableOperations</a>&nbsp;ops,
<a href="../../../org/apache/iceberg/Table.html" title="interface in org.apache.iceberg">Table</a>&nbsp;table,
<a href="../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg">Schema</a>&nbsp;schema,
org.apache.iceberg.TableScanContext&nbsp;context)</pre>
</li>
</ul>
<a name="doPlanFiles--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>doPlanFiles</h4>
<pre>public&nbsp;<a href="../../../org/apache/iceberg/io/CloseableIterable.html" title="interface in org.apache.iceberg.io">CloseableIterable</a>&lt;<a href="../../../org/apache/iceberg/FileScanTask.html" title="interface in org.apache.iceberg">FileScanTask</a>&gt;&nbsp;doPlanFiles()</pre>
</li>
</ul>
<a name="snapshotId--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>snapshotId</h4>
<pre>protected&nbsp;java.lang.Long&nbsp;snapshotId()</pre>
</li>
</ul>
<a name="colStats--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>colStats</h4>
<pre>@Deprecated
protected&nbsp;boolean&nbsp;colStats()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">Will be removed in 1.2.0, use <code>TableScanContext.returnColumnStats()</code>
directly.</span></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether column stats are returned.</dd>
</dl>
</li>
</ul>
<a name="options--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>options</h4>
<pre>protected&nbsp;java.util.Map&lt;java.lang.String,java.lang.String&gt;&nbsp;options()</pre>
</li>
</ul>
<a name="scanMetrics--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>scanMetrics</h4>
<pre>protected&nbsp;<a href="../../../org/apache/iceberg/metrics/ScanMetrics.html" title="class in org.apache.iceberg.metrics">ScanMetrics</a>&nbsp;scanMetrics()</pre>
</li>
</ul>
<a name="table--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>table</h4>
<pre>public&nbsp;<a href="../../../org/apache/iceberg/Table.html" title="interface in org.apache.iceberg">Table</a>&nbsp;table()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../org/apache/iceberg/TableScan.html#table--">TableScan</a></code></span></div>
<div class="block">Returns the <a href="../../../org/apache/iceberg/Table.html" title="interface in org.apache.iceberg"><code>Table</code></a> from which this scan loads data.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../org/apache/iceberg/TableScan.html#table--">table</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/apache/iceberg/TableScan.html" title="interface in org.apache.iceberg">TableScan</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this scan's table</dd>
</dl>
</li>
</ul>
<a name="useRef-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>useRef</h4>
<pre>public&nbsp;<a href="../../../org/apache/iceberg/TableScan.html" title="interface in org.apache.iceberg">TableScan</a>&nbsp;useRef(java.lang.String&nbsp;name)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../org/apache/iceberg/TableScan.html#useRef-java.lang.String-">TableScan</a></code></span></div>
<div class="block">Create a new <a href="../../../org/apache/iceberg/TableScan.html" title="interface in org.apache.iceberg"><code>TableScan</code></a> from this scan's configuration that will use the given
reference.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../org/apache/iceberg/TableScan.html#useRef-java.lang.String-">useRef</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/apache/iceberg/TableScan.html" title="interface in org.apache.iceberg">TableScan</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - reference</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a new scan based on the given reference.</dd>
</dl>
</li>
</ul>
<a name="asOfTime-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>asOfTime</h4>
<pre>public&nbsp;<a href="../../../org/apache/iceberg/TableScan.html" title="interface in org.apache.iceberg">TableScan</a>&nbsp;asOfTime(long&nbsp;timestampMillis)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../org/apache/iceberg/TableScan.html#asOfTime-long-">TableScan</a></code></span></div>
<div class="block">Create a new <a href="../../../org/apache/iceberg/TableScan.html" title="interface in org.apache.iceberg"><code>TableScan</code></a> from this scan's configuration that will use the most recent
snapshot as of the given time in milliseconds on the branch in the scan or main if no branch is
set.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../org/apache/iceberg/TableScan.html#asOfTime-long-">asOfTime</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/apache/iceberg/TableScan.html" title="interface in org.apache.iceberg">TableScan</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>timestampMillis</code> - a timestamp in milliseconds.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a new scan based on this with the current snapshot at the given time</dd>
</dl>
</li>
</ul>
<a name="planFiles--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>planFiles</h4>
<pre>public&nbsp;<a href="../../../org/apache/iceberg/io/CloseableIterable.html" title="interface in org.apache.iceberg.io">CloseableIterable</a>&lt;<a href="../../../org/apache/iceberg/FileScanTask.html" title="interface in org.apache.iceberg">FileScanTask</a>&gt;&nbsp;planFiles()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../org/apache/iceberg/Scan.html#planFiles--">Scan</a></code></span></div>
<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>Scan.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="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../org/apache/iceberg/Scan.html#planFiles--">planFiles</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/apache/iceberg/Scan.html" title="interface in org.apache.iceberg">Scan</a>&lt;<a href="../../../org/apache/iceberg/TableScan.html" title="interface in org.apache.iceberg">TableScan</a>,<a href="../../../org/apache/iceberg/FileScanTask.html" title="interface in org.apache.iceberg">FileScanTask</a>,<a href="../../../org/apache/iceberg/CombinedScanTask.html" title="interface in org.apache.iceberg">CombinedScanTask</a>&gt;</code></dd>
<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>public&nbsp;<a href="../../../org/apache/iceberg/io/CloseableIterable.html" title="interface in org.apache.iceberg.io">CloseableIterable</a>&lt;<a href="../../../org/apache/iceberg/CombinedScanTask.html" title="interface in org.apache.iceberg">CombinedScanTask</a>&gt;&nbsp;planTasks()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../org/apache/iceberg/Scan.html#planTasks--">Scan</a></code></span></div>
<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="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../org/apache/iceberg/Scan.html#planTasks--">planTasks</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/apache/iceberg/Scan.html" title="interface in org.apache.iceberg">Scan</a>&lt;<a href="../../../org/apache/iceberg/TableScan.html" title="interface in org.apache.iceberg">TableScan</a>,<a href="../../../org/apache/iceberg/FileScanTask.html" title="interface in org.apache.iceberg">FileScanTask</a>,<a href="../../../org/apache/iceberg/CombinedScanTask.html" title="interface in org.apache.iceberg">CombinedScanTask</a>&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an Iterable of balanced task groups required by this scan</dd>
</dl>
</li>
</ul>
<a name="snapshot--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>snapshot</h4>
<pre>public&nbsp;<a href="../../../org/apache/iceberg/Snapshot.html" title="interface in org.apache.iceberg">Snapshot</a>&nbsp;snapshot()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../org/apache/iceberg/TableScan.html#snapshot--">TableScan</a></code></span></div>
<div class="block">Returns the <a href="../../../org/apache/iceberg/Snapshot.html" title="interface in org.apache.iceberg"><code>Snapshot</code></a> that will be used by this scan.
<p>If the snapshot was not configured using <a href="../../../org/apache/iceberg/TableScan.html#asOfTime-long-"><code>TableScan.asOfTime(long)</code></a> or <a href="../../../org/apache/iceberg/TableScan.html#useSnapshot-long-"><code>TableScan.useSnapshot(long)</code></a>, the current table snapshot will be used.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../org/apache/iceberg/TableScan.html#snapshot--">snapshot</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/apache/iceberg/TableScan.html" title="interface in org.apache.iceberg">TableScan</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the Snapshot this scan will use</dd>
</dl>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a name="tableOps--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>tableOps</h4>
<pre>protected&nbsp;<a href="../../../org/apache/iceberg/TableOperations.html" title="interface in org.apache.iceberg">TableOperations</a>&nbsp;tableOps()</pre>
</li>
</ul>
<a name="tableSchema--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>tableSchema</h4>
<pre>protected&nbsp;<a href="../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg">Schema</a>&nbsp;tableSchema()</pre>
</li>
</ul>
<a name="context--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>context</h4>
<pre>protected&nbsp;org.apache.iceberg.TableScanContext&nbsp;context()</pre>
</li>
</ul>
<a name="scanColumns--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>scanColumns</h4>
<pre>protected&nbsp;java.util.List&lt;java.lang.String&gt;&nbsp;scanColumns()</pre>
</li>
</ul>
<a name="shouldIgnoreResiduals--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shouldIgnoreResiduals</h4>
<pre>protected&nbsp;boolean&nbsp;shouldIgnoreResiduals()</pre>
</li>
</ul>
<a name="shouldPlanWithExecutor--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shouldPlanWithExecutor</h4>
<pre>protected&nbsp;boolean&nbsp;shouldPlanWithExecutor()</pre>
</li>
</ul>
<a name="planExecutor--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>planExecutor</h4>
<pre>protected&nbsp;java.util.concurrent.ExecutorService&nbsp;planExecutor()</pre>
</li>
</ul>
<a name="option-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>option</h4>
<pre>public&nbsp;ThisT&nbsp;option(java.lang.String&nbsp;property,
java.lang.String&nbsp;value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../org/apache/iceberg/Scan.html#option-java.lang.String-java.lang.String-">Scan</a></code></span></div>
<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="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../org/apache/iceberg/Scan.html#option-java.lang.String-java.lang.String-">option</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/apache/iceberg/Scan.html" title="interface in org.apache.iceberg">Scan</a>&lt;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>&lt;T&gt;&gt;</code></dd>
<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>public&nbsp;ThisT&nbsp;project(<a href="../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg">Schema</a>&nbsp;projectedSchema)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../org/apache/iceberg/Scan.html#project-org.apache.iceberg.Schema-">Scan</a></code></span></div>
<div class="block">Create a new scan from this with the schema as its projection.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../org/apache/iceberg/Scan.html#project-org.apache.iceberg.Schema-">project</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/apache/iceberg/Scan.html" title="interface in org.apache.iceberg">Scan</a>&lt;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>&lt;T&gt;&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>projectedSchema</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>public&nbsp;ThisT&nbsp;caseSensitive(boolean&nbsp;caseSensitive)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../org/apache/iceberg/Scan.html#caseSensitive-boolean-">Scan</a></code></span></div>
<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>Scan.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="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../org/apache/iceberg/Scan.html#caseSensitive-boolean-">caseSensitive</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/apache/iceberg/Scan.html" title="interface in org.apache.iceberg">Scan</a>&lt;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>&lt;T&gt;&gt;</code></dd>
<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>public&nbsp;boolean&nbsp;isCaseSensitive()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../org/apache/iceberg/Scan.html#isCaseSensitive--">Scan</a></code></span></div>
<div class="block">Returns whether this scan is case-sensitive with respect to column names.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../org/apache/iceberg/Scan.html#isCaseSensitive--">isCaseSensitive</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/apache/iceberg/Scan.html" title="interface in org.apache.iceberg">Scan</a>&lt;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>&lt;T&gt;&gt;</code></dd>
<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>public&nbsp;ThisT&nbsp;includeColumnStats()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../org/apache/iceberg/Scan.html#includeColumnStats--">Scan</a></code></span></div>
<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="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../org/apache/iceberg/Scan.html#includeColumnStats--">includeColumnStats</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/apache/iceberg/Scan.html" title="interface in org.apache.iceberg">Scan</a>&lt;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>&lt;T&gt;&gt;</code></dd>
<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>public&nbsp;ThisT&nbsp;select(java.util.Collection&lt;java.lang.String&gt;&nbsp;columns)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../org/apache/iceberg/Scan.html#select-java.util.Collection-">Scan</a></code></span></div>
<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="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../org/apache/iceberg/Scan.html#select-java.util.Collection-">select</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/apache/iceberg/Scan.html" title="interface in org.apache.iceberg">Scan</a>&lt;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>&lt;T&gt;&gt;</code></dd>
<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="filter-org.apache.iceberg.expressions.Expression-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>filter</h4>
<pre>public&nbsp;ThisT&nbsp;filter(<a href="../../../org/apache/iceberg/expressions/Expression.html" title="interface in org.apache.iceberg.expressions">Expression</a>&nbsp;expr)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../org/apache/iceberg/Scan.html#filter-org.apache.iceberg.expressions.Expression-">Scan</a></code></span></div>
<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="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../org/apache/iceberg/Scan.html#filter-org.apache.iceberg.expressions.Expression-">filter</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/apache/iceberg/Scan.html" title="interface in org.apache.iceberg">Scan</a>&lt;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>&lt;T&gt;&gt;</code></dd>
<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>public&nbsp;<a href="../../../org/apache/iceberg/expressions/Expression.html" title="interface in org.apache.iceberg.expressions">Expression</a>&nbsp;filter()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../org/apache/iceberg/Scan.html#filter--">Scan</a></code></span></div>
<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="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../org/apache/iceberg/Scan.html#filter--">filter</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/apache/iceberg/Scan.html" title="interface in org.apache.iceberg">Scan</a>&lt;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>&lt;T&gt;&gt;</code></dd>
<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>public&nbsp;ThisT&nbsp;ignoreResiduals()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../org/apache/iceberg/Scan.html#ignoreResiduals--">Scan</a></code></span></div>
<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="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../org/apache/iceberg/Scan.html#ignoreResiduals--">ignoreResiduals</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/apache/iceberg/Scan.html" title="interface in org.apache.iceberg">Scan</a>&lt;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>&lt;T&gt;&gt;</code></dd>
<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>public&nbsp;ThisT&nbsp;planWith(java.util.concurrent.ExecutorService&nbsp;executorService)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../org/apache/iceberg/Scan.html#planWith-java.util.concurrent.ExecutorService-">Scan</a></code></span></div>
<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="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../org/apache/iceberg/Scan.html#planWith-java.util.concurrent.ExecutorService-">planWith</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/apache/iceberg/Scan.html" title="interface in org.apache.iceberg">Scan</a>&lt;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>&lt;T&gt;&gt;</code></dd>
<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>public&nbsp;<a href="../../../org/apache/iceberg/Schema.html" title="class in org.apache.iceberg">Schema</a>&nbsp;schema()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../org/apache/iceberg/Scan.html#schema--">Scan</a></code></span></div>
<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>Scan.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>Scan.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="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../org/apache/iceberg/Scan.html#schema--">schema</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/apache/iceberg/Scan.html" title="interface in org.apache.iceberg">Scan</a>&lt;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>&lt;T&gt;&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this scan's projection schema</dd>
</dl>
</li>
</ul>
<a name="targetSplitSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>targetSplitSize</h4>
<pre>public&nbsp;long&nbsp;targetSplitSize()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../org/apache/iceberg/Scan.html#targetSplitSize--">Scan</a></code></span></div>
<div class="block">Returns the target split size for this scan.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../org/apache/iceberg/Scan.html#targetSplitSize--">targetSplitSize</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/apache/iceberg/Scan.html" title="interface in org.apache.iceberg">Scan</a>&lt;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>&lt;T&gt;&gt;</code></dd>
</dl>
</li>
</ul>
<a name="splitLookback--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>splitLookback</h4>
<pre>public&nbsp;int&nbsp;splitLookback()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../org/apache/iceberg/Scan.html#splitLookback--">Scan</a></code></span></div>
<div class="block">Returns the split lookback for this scan.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../org/apache/iceberg/Scan.html#splitLookback--">splitLookback</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/apache/iceberg/Scan.html" title="interface in org.apache.iceberg">Scan</a>&lt;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>&lt;T&gt;&gt;</code></dd>
</dl>
</li>
</ul>
<a name="splitOpenFileCost--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>splitOpenFileCost</h4>
<pre>public&nbsp;long&nbsp;splitOpenFileCost()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../org/apache/iceberg/Scan.html#splitOpenFileCost--">Scan</a></code></span></div>
<div class="block">Returns the split open file cost for this scan.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../org/apache/iceberg/Scan.html#splitOpenFileCost--">splitOpenFileCost</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/apache/iceberg/Scan.html" title="interface in org.apache.iceberg">Scan</a>&lt;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>&lt;T&gt;&gt;</code></dd>
</dl>
</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/DataOperations.html" title="class in org.apache.iceberg"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../org/apache/iceberg/DataTask.html" title="interface in org.apache.iceberg"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/apache/iceberg/DataTableScan.html" target="_top">Frames</a></li>
<li><a href="DataTableScan.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>