blob: 8693fa3efe2c185666e152bfb1e2933b394dd8b3 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>RollbackStagedTable</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="RollbackStagedTable";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&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 id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.iceberg.spark</a></div>
<h2 title="Class RollbackStagedTable" class="title">Class RollbackStagedTable</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.iceberg.spark.RollbackStagedTable</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code>org.apache.spark.sql.connector.catalog.StagedTable</code>, <code>org.apache.spark.sql.connector.catalog.SupportsDelete</code>, <code>org.apache.spark.sql.connector.catalog.SupportsRead</code>, <code>org.apache.spark.sql.connector.catalog.SupportsWrite</code>, <code>org.apache.spark.sql.connector.catalog.Table</code>, <code>org.apache.spark.sql.connector.catalog.TruncatableTable</code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">RollbackStagedTable</span>
extends java.lang.Object
implements org.apache.spark.sql.connector.catalog.StagedTable, org.apache.spark.sql.connector.catalog.SupportsRead, org.apache.spark.sql.connector.catalog.SupportsWrite, org.apache.spark.sql.connector.catalog.SupportsDelete</pre>
<div class="block">An implementation of StagedTable that mimics the behavior of Spark's non-atomic CTAS and RTAS.
<p>
A Spark catalog can implement StagingTableCatalog to support atomic operations by producing StagedTable. But if a
catalog implements StagingTableCatalog, Spark expects the catalog to be able to produce a StagedTable for any table
loaded by the catalog. This assumption doesn't always work, as in the case of <a href="SparkSessionCatalog.html" title="class in org.apache.iceberg.spark"><code>SparkSessionCatalog</code></a>, which
supports atomic operations can produce a StagedTable for Iceberg tables, but wraps the session catalog and cannot
necessarily produce a working StagedTable implementation for tables that it loads.
<p>
The work-around is this class, which implements the StagedTable interface but does not have atomic behavior. Instead,
the StagedTable interface is used to implement the behavior of the non-atomic SQL plans that will create a table,
write, and will drop the table to roll back.
<p>
This StagedTable implements SupportsRead, SupportsWrite, and SupportsDelete by passing the calls to the real table.
Implementing those interfaces is safe because Spark will not use them unless the table supports them and returns the
corresponding capabilities from <a href="#capabilities()"><code>capabilities()</code></a>.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.spark.sql.connector.catalog.TableCatalog,org.apache.spark.sql.connector.catalog.Identifier,org.apache.spark.sql.connector.catalog.Table)">RollbackStagedTable</a></span>&#8203;(org.apache.spark.sql.connector.catalog.TableCatalog&nbsp;catalog,
org.apache.spark.sql.connector.catalog.Identifier&nbsp;ident,
org.apache.spark.sql.connector.catalog.Table&nbsp;table)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&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="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#abortStagedChanges()">abortStagedChanges</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.util.Set&lt;org.apache.spark.sql.connector.catalog.TableCapability&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#capabilities()">capabilities</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#commitStagedChanges()">commitStagedChanges</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#deleteWhere(org.apache.spark.sql.sources.Filter%5B%5D)">deleteWhere</a></span>&#8203;(org.apache.spark.sql.sources.Filter[]&nbsp;filters)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#name()">name</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>org.apache.spark.sql.connector.read.ScanBuilder</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newScanBuilder(org.apache.spark.sql.util.CaseInsensitiveStringMap)">newScanBuilder</a></span>&#8203;(org.apache.spark.sql.util.CaseInsensitiveStringMap&nbsp;options)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>org.apache.spark.sql.connector.write.WriteBuilder</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newWriteBuilder(org.apache.spark.sql.connector.write.LogicalWriteInfo)">newWriteBuilder</a></span>&#8203;(org.apache.spark.sql.connector.write.LogicalWriteInfo&nbsp;info)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>org.apache.spark.sql.connector.expressions.Transform[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#partitioning()">partitioning</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>java.util.Map&lt;java.lang.String,&#8203;java.lang.String&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#properties()">properties</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>org.apache.spark.sql.types.StructType</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#schema()">schema</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="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 id="methods.inherited.from.class.org.apache.spark.sql.connector.catalog.SupportsDelete">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.spark.sql.connector.catalog.SupportsDelete</h3>
<code>canDeleteWhere, truncateTable</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;(org.apache.spark.sql.connector.catalog.TableCatalog,org.apache.spark.sql.connector.catalog.Identifier,org.apache.spark.sql.connector.catalog.Table)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>RollbackStagedTable</h4>
<pre>public&nbsp;RollbackStagedTable&#8203;(org.apache.spark.sql.connector.catalog.TableCatalog&nbsp;catalog,
org.apache.spark.sql.connector.catalog.Identifier&nbsp;ident,
org.apache.spark.sql.connector.catalog.Table&nbsp;table)</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="commitStagedChanges()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>commitStagedChanges</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;commitStagedChanges()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>commitStagedChanges</code>&nbsp;in interface&nbsp;<code>org.apache.spark.sql.connector.catalog.StagedTable</code></dd>
</dl>
</li>
</ul>
<a id="abortStagedChanges()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>abortStagedChanges</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;abortStagedChanges()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>abortStagedChanges</code>&nbsp;in interface&nbsp;<code>org.apache.spark.sql.connector.catalog.StagedTable</code></dd>
</dl>
</li>
</ul>
<a id="name()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>name</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;name()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>name</code>&nbsp;in interface&nbsp;<code>org.apache.spark.sql.connector.catalog.Table</code></dd>
</dl>
</li>
</ul>
<a id="schema()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>schema</h4>
<pre class="methodSignature">public&nbsp;org.apache.spark.sql.types.StructType&nbsp;schema()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>schema</code>&nbsp;in interface&nbsp;<code>org.apache.spark.sql.connector.catalog.Table</code></dd>
</dl>
</li>
</ul>
<a id="partitioning()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>partitioning</h4>
<pre class="methodSignature">public&nbsp;org.apache.spark.sql.connector.expressions.Transform[]&nbsp;partitioning()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>partitioning</code>&nbsp;in interface&nbsp;<code>org.apache.spark.sql.connector.catalog.Table</code></dd>
</dl>
</li>
</ul>
<a id="properties()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>properties</h4>
<pre class="methodSignature">public&nbsp;java.util.Map&lt;java.lang.String,&#8203;java.lang.String&gt;&nbsp;properties()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>properties</code>&nbsp;in interface&nbsp;<code>org.apache.spark.sql.connector.catalog.Table</code></dd>
</dl>
</li>
</ul>
<a id="capabilities()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>capabilities</h4>
<pre class="methodSignature">public&nbsp;java.util.Set&lt;org.apache.spark.sql.connector.catalog.TableCapability&gt;&nbsp;capabilities()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>capabilities</code>&nbsp;in interface&nbsp;<code>org.apache.spark.sql.connector.catalog.Table</code></dd>
</dl>
</li>
</ul>
<a id="deleteWhere(org.apache.spark.sql.sources.Filter[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deleteWhere</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;deleteWhere&#8203;(org.apache.spark.sql.sources.Filter[]&nbsp;filters)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>deleteWhere</code>&nbsp;in interface&nbsp;<code>org.apache.spark.sql.connector.catalog.SupportsDelete</code></dd>
</dl>
</li>
</ul>
<a id="newScanBuilder(org.apache.spark.sql.util.CaseInsensitiveStringMap)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newScanBuilder</h4>
<pre class="methodSignature">public&nbsp;org.apache.spark.sql.connector.read.ScanBuilder&nbsp;newScanBuilder&#8203;(org.apache.spark.sql.util.CaseInsensitiveStringMap&nbsp;options)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>newScanBuilder</code>&nbsp;in interface&nbsp;<code>org.apache.spark.sql.connector.catalog.SupportsRead</code></dd>
</dl>
</li>
</ul>
<a id="newWriteBuilder(org.apache.spark.sql.connector.write.LogicalWriteInfo)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>newWriteBuilder</h4>
<pre class="methodSignature">public&nbsp;org.apache.spark.sql.connector.write.WriteBuilder&nbsp;newWriteBuilder&#8203;(org.apache.spark.sql.connector.write.LogicalWriteInfo&nbsp;info)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>newWriteBuilder</code>&nbsp;in interface&nbsp;<code>org.apache.spark.sql.connector.catalog.SupportsWrite</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses.html">All&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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</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 id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
</body>
</html>