blob: 251564a5ed7ec34a83d76d1970cc3f0df99638be [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>SerializableTableWithSize</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="SerializableTableWithSize";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":9,"i2":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/spark/source/IcebergSource.html" title="class in org.apache.iceberg.spark.source"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/iceberg/spark/source/SerializableTableWithSize.SerializableMetadataTableWithSize.html" title="class in org.apache.iceberg.spark.source"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/iceberg/spark/source/SerializableTableWithSize.html" target="_top">Frames</a></li>
<li><a href="SerializableTableWithSize.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><a href="#nested.class.summary">Nested</a>&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.spark.source</div>
<h2 title="Class SerializableTableWithSize" class="title">Class SerializableTableWithSize</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/iceberg/SerializableTable.html" title="class in org.apache.iceberg">org.apache.iceberg.SerializableTable</a></li>
<li>
<ul class="inheritance">
<li>org.apache.iceberg.spark.source.SerializableTableWithSize</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable, java.lang.AutoCloseable, <a href="../../../../../org/apache/iceberg/HasTableOperations.html" title="interface in org.apache.iceberg">HasTableOperations</a>, <a href="../../../../../org/apache/iceberg/Table.html" title="interface in org.apache.iceberg">Table</a>, org.apache.spark.util.KnownSizeEstimation</dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">SerializableTableWithSize</span>
extends <a href="../../../../../org/apache/iceberg/SerializableTable.html" title="class in org.apache.iceberg">SerializableTable</a>
implements org.apache.spark.util.KnownSizeEstimation, java.lang.AutoCloseable</pre>
<div class="block">This class provides a serializable table with a known size estimate. Spark calls its
SizeEstimator class when broadcasting variables and this can be an expensive operation, so
providing a known size estimate allows that operation to be skipped.
<p>This class also implements AutoCloseable to avoid leaking resources upon broadcasting.
Broadcast variables are destroyed and cleaned up on the driver and executors once they are
garbage collected on the driver. The implementation ensures only resources used by copies of the
main table are released.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../serialized-form.html#org.apache.iceberg.spark.source.SerializableTableWithSize">Serialized Form</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/iceberg/spark/source/SerializableTableWithSize.SerializableMetadataTableWithSize.html" title="class in org.apache.iceberg.spark.source">SerializableTableWithSize.SerializableMetadataTableWithSize</a></span></code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.iceberg.SerializableTable">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class&nbsp;org.apache.iceberg.<a href="../../../../../org/apache/iceberg/SerializableTable.html" title="class in org.apache.iceberg">SerializableTable</a></h3>
<code><a href="../../../../../org/apache/iceberg/SerializableTable.SerializableMetadataTable.html" title="class in org.apache.iceberg">SerializableTable.SerializableMetadataTable</a></code></li>
</ul>
</li>
</ul>
<!-- ======== 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>protected </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/iceberg/spark/source/SerializableTableWithSize.html#SerializableTableWithSize-org.apache.iceberg.Table-">SerializableTableWithSize</a></span>(<a href="../../../../../org/apache/iceberg/Table.html" title="interface in org.apache.iceberg">Table</a>&nbsp;table)</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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></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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/iceberg/spark/source/SerializableTableWithSize.html#close--">close</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static <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/spark/source/SerializableTableWithSize.html#copyOf-org.apache.iceberg.Table-">copyOf</a></span>(<a href="../../../../../org/apache/iceberg/Table.html" title="interface in org.apache.iceberg">Table</a>&nbsp;table)</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/iceberg/spark/source/SerializableTableWithSize.html#estimatedSize--">estimatedSize</a></span>()</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.iceberg.SerializableTable">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.iceberg.<a href="../../../../../org/apache/iceberg/SerializableTable.html" title="class in org.apache.iceberg">SerializableTable</a></h3>
<code><a href="../../../../../org/apache/iceberg/SerializableTable.html#currentSnapshot--">currentSnapshot</a>, <a href="../../../../../org/apache/iceberg/SerializableTable.html#encryption--">encryption</a>, <a href="../../../../../org/apache/iceberg/SerializableTable.html#expireSnapshots--">expireSnapshots</a>, <a href="../../../../../org/apache/iceberg/SerializableTable.html#history--">history</a>, <a href="../../../../../org/apache/iceberg/SerializableTable.html#io--">io</a>, <a href="../../../../../org/apache/iceberg/SerializableTable.html#location--">location</a>, <a href="../../../../../org/apache/iceberg/SerializableTable.html#locationProvider--">locationProvider</a>, <a href="../../../../../org/apache/iceberg/SerializableTable.html#manageSnapshots--">manageSnapshots</a>, <a href="../../../../../org/apache/iceberg/SerializableTable.html#name--">name</a>, <a href="../../../../../org/apache/iceberg/SerializableTable.html#newAppend--">newAppend</a>, <a href="../../../../../org/apache/iceberg/SerializableTable.html#newBatchScan--">newBatchScan</a>, <a href="../../../../../org/apache/iceberg/SerializableTable.html#newDelete--">newDelete</a>, <a href="../../../../../org/apache/iceberg/SerializableTable.html#newOverwrite--">newOverwrite</a>, <a href="../../../../../org/apache/iceberg/SerializableTable.html#newReplacePartitions--">newReplacePartitions</a>, <a href="../../../../../org/apache/iceberg/SerializableTable.html#newRewrite--">newRewrite</a>, <a href="../../../../../org/apache/iceberg/SerializableTable.html#newRowDelta--">newRowDelta</a>, <a href="../../../../../org/apache/iceberg/SerializableTable.html#newScan--">newScan</a>, <a href="../../../../../org/apache/iceberg/SerializableTable.html#newTable-org.apache.iceberg.TableOperations-java.lang.String-">newTable</a>, <a href="../../../../../org/apache/iceberg/SerializableTable.html#newTransaction--">newTransaction</a>, <a href="../../../../../org/apache/iceberg/SerializableTable.html#operations--">operations</a>, <a href="../../../../../org/apache/iceberg/SerializableTable.html#partitionStatisticsFiles--">partitionStatisticsFiles</a>, <a href="../../../../../org/apache/iceberg/SerializableTable.html#properties--">properties</a>, <a href="../../../../../org/apache/iceberg/SerializableTable.html#refresh--">refresh</a>, <a href="../../../../../org/apache/iceberg/SerializableTable.html#refs--">refs</a>, <a href="../../../../../org/apache/iceberg/SerializableTable.html#replaceSortOrder--">replaceSortOrder</a>, <a href="../../../../../org/apache/iceberg/SerializableTable.html#rewriteManifests--">rewriteManifests</a>, <a href="../../../../../org/apache/iceberg/SerializableTable.html#schema--">schema</a>, <a href="../../../../../org/apache/iceberg/SerializableTable.html#schemas--">schemas</a>, <a href="../../../../../org/apache/iceberg/SerializableTable.html#snapshot-long-">snapshot</a>, <a href="../../../../../org/apache/iceberg/SerializableTable.html#snapshots--">snapshots</a>, <a href="../../../../../org/apache/iceberg/SerializableTable.html#sortOrder--">sortOrder</a>, <a href="../../../../../org/apache/iceberg/SerializableTable.html#sortOrders--">sortOrders</a>, <a href="../../../../../org/apache/iceberg/SerializableTable.html#spec--">spec</a>, <a href="../../../../../org/apache/iceberg/SerializableTable.html#specs--">specs</a>, <a href="../../../../../org/apache/iceberg/SerializableTable.html#statisticsFiles--">statisticsFiles</a>, <a href="../../../../../org/apache/iceberg/SerializableTable.html#updateLocation--">updateLocation</a>, <a href="../../../../../org/apache/iceberg/SerializableTable.html#updatePartitionStatistics--">updatePartitionStatistics</a>, <a href="../../../../../org/apache/iceberg/SerializableTable.html#updateProperties--">updateProperties</a>, <a href="../../../../../org/apache/iceberg/SerializableTable.html#updateSchema--">updateSchema</a>, <a href="../../../../../org/apache/iceberg/SerializableTable.html#updateSpec--">updateSpec</a>, <a href="../../../../../org/apache/iceberg/SerializableTable.html#updateStatistics--">updateStatistics</a>, <a href="../../../../../org/apache/iceberg/SerializableTable.html#uuid--">uuid</a></code></li>
</ul>
<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, toString, wait, wait, wait</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.iceberg.Table">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.iceberg.<a href="../../../../../org/apache/iceberg/Table.html" title="interface in org.apache.iceberg">Table</a></h3>
<code><a href="../../../../../org/apache/iceberg/Table.html#newFastAppend--">newFastAppend</a>, <a href="../../../../../org/apache/iceberg/Table.html#newIncrementalAppendScan--">newIncrementalAppendScan</a>, <a href="../../../../../org/apache/iceberg/Table.html#newIncrementalChangelogScan--">newIncrementalChangelogScan</a>, <a href="../../../../../org/apache/iceberg/Table.html#snapshot-java.lang.String-">snapshot</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="SerializableTableWithSize-org.apache.iceberg.Table-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SerializableTableWithSize</h4>
<pre>protected&nbsp;SerializableTableWithSize(<a href="../../../../../org/apache/iceberg/Table.html" title="interface in org.apache.iceberg">Table</a>&nbsp;table)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="estimatedSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>estimatedSize</h4>
<pre>public&nbsp;long&nbsp;estimatedSize()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>estimatedSize</code>&nbsp;in interface&nbsp;<code>org.apache.spark.util.KnownSizeEstimation</code></dd>
</dl>
</li>
</ul>
<a name="copyOf-org.apache.iceberg.Table-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>copyOf</h4>
<pre>public static&nbsp;<a href="../../../../../org/apache/iceberg/Table.html" title="interface in org.apache.iceberg">Table</a>&nbsp;copyOf(<a href="../../../../../org/apache/iceberg/Table.html" title="interface in org.apache.iceberg">Table</a>&nbsp;table)</pre>
</li>
</ul>
<a name="close--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>close</h4>
<pre>public&nbsp;void&nbsp;close()
throws java.lang.Exception</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>close</code>&nbsp;in interface&nbsp;<code>java.lang.AutoCloseable</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</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/spark/source/IcebergSource.html" title="class in org.apache.iceberg.spark.source"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/iceberg/spark/source/SerializableTableWithSize.SerializableMetadataTableWithSize.html" title="class in org.apache.iceberg.spark.source"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/iceberg/spark/source/SerializableTableWithSize.html" target="_top">Frames</a></li>
<li><a href="SerializableTableWithSize.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><a href="#nested.class.summary">Nested</a>&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>