blob: b692ec226c43f57ef2f068dbf0aee4f42f468126 [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>TableCommit</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="TableCommit";
}
}
catch(err) {
}
//-->
var methods = {"i0":17,"i1":6,"i2":6,"i3":6};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/iceberg/catalog/SupportsNamespaces.html" title="interface in org.apache.iceberg.catalog"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/iceberg/catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/iceberg/catalog/TableCommit.html" target="_top">Frames</a></li>
<li><a href="TableCommit.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>Constr&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>Constr&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.catalog</div>
<h2 title="Interface TableCommit" class="title">Interface TableCommit</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>@Value.Immutable
public interface <span class="typeNameLabel">TableCommit</span></pre>
<div class="block">This represents a commit to be applied for a single table with <a href="../../../../org/apache/iceberg/UpdateRequirement.html" title="interface in org.apache.iceberg"><code>UpdateRequirement</code></a>s to be
validated and <a href="../../../../org/apache/iceberg/MetadataUpdate.html" title="interface in org.apache.iceberg"><code>MetadataUpdate</code></a>s that have been applied. The <a href="../../../../org/apache/iceberg/UpdateRequirement.html" title="interface in org.apache.iceberg"><code>UpdateRequirement</code></a>s and
<a href="../../../../org/apache/iceberg/MetadataUpdate.html" title="interface in org.apache.iceberg"><code>MetadataUpdate</code></a>s can be derived from table's base and updated <a href="../../../../org/apache/iceberg/TableMetadata.html" title="class in org.apache.iceberg"><code>TableMetadata</code></a> when
using <a href="../../../../org/apache/iceberg/catalog/TableCommit.html#create-org.apache.iceberg.catalog.TableIdentifier-org.apache.iceberg.TableMetadata-org.apache.iceberg.TableMetadata-"><code>create(TableIdentifier, TableMetadata, TableMetadata)</code></a>.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default 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>static <a href="../../../../org/apache/iceberg/catalog/TableCommit.html" title="interface in org.apache.iceberg.catalog">TableCommit</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/catalog/TableCommit.html#create-org.apache.iceberg.catalog.TableIdentifier-org.apache.iceberg.TableMetadata-org.apache.iceberg.TableMetadata-">create</a></span>(<a href="../../../../org/apache/iceberg/catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a>&nbsp;identifier,
<a href="../../../../org/apache/iceberg/TableMetadata.html" title="class in org.apache.iceberg">TableMetadata</a>&nbsp;base,
<a href="../../../../org/apache/iceberg/TableMetadata.html" title="class in org.apache.iceberg">TableMetadata</a>&nbsp;updated)</code>
<div class="block">This creates a <a href="../../../../org/apache/iceberg/catalog/TableCommit.html" title="interface in org.apache.iceberg.catalog"><code>TableCommit</code></a> instance to be applied for a single table with <a href="../../../../org/apache/iceberg/UpdateRequirement.html" title="interface in org.apache.iceberg"><code>UpdateRequirement</code></a>s to be validated and <a href="../../../../org/apache/iceberg/MetadataUpdate.html" title="interface in org.apache.iceberg"><code>MetadataUpdate</code></a>s that have been applied.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/iceberg/catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/catalog/TableCommit.html#identifier--">identifier</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../../../../org/apache/iceberg/UpdateRequirement.html" title="interface in org.apache.iceberg">UpdateRequirement</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/catalog/TableCommit.html#requirements--">requirements</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../../../../org/apache/iceberg/MetadataUpdate.html" title="interface in org.apache.iceberg">MetadataUpdate</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/catalog/TableCommit.html#updates--">updates</a></span>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="identifier--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>identifier</h4>
<pre><a href="../../../../org/apache/iceberg/catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a>&nbsp;identifier()</pre>
</li>
</ul>
<a name="requirements--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>requirements</h4>
<pre>java.util.List&lt;<a href="../../../../org/apache/iceberg/UpdateRequirement.html" title="interface in org.apache.iceberg">UpdateRequirement</a>&gt;&nbsp;requirements()</pre>
</li>
</ul>
<a name="updates--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updates</h4>
<pre>java.util.List&lt;<a href="../../../../org/apache/iceberg/MetadataUpdate.html" title="interface in org.apache.iceberg">MetadataUpdate</a>&gt;&nbsp;updates()</pre>
</li>
</ul>
<a name="create-org.apache.iceberg.catalog.TableIdentifier-org.apache.iceberg.TableMetadata-org.apache.iceberg.TableMetadata-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>create</h4>
<pre>static&nbsp;<a href="../../../../org/apache/iceberg/catalog/TableCommit.html" title="interface in org.apache.iceberg.catalog">TableCommit</a>&nbsp;create(<a href="../../../../org/apache/iceberg/catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a>&nbsp;identifier,
<a href="../../../../org/apache/iceberg/TableMetadata.html" title="class in org.apache.iceberg">TableMetadata</a>&nbsp;base,
<a href="../../../../org/apache/iceberg/TableMetadata.html" title="class in org.apache.iceberg">TableMetadata</a>&nbsp;updated)</pre>
<div class="block">This creates a <a href="../../../../org/apache/iceberg/catalog/TableCommit.html" title="interface in org.apache.iceberg.catalog"><code>TableCommit</code></a> instance to be applied for a single table with <a href="../../../../org/apache/iceberg/UpdateRequirement.html" title="interface in org.apache.iceberg"><code>UpdateRequirement</code></a>s to be validated and <a href="../../../../org/apache/iceberg/MetadataUpdate.html" title="interface in org.apache.iceberg"><code>MetadataUpdate</code></a>s that have been applied.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>identifier</code> - The <a href="../../../../org/apache/iceberg/catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog"><code>TableIdentifier</code></a> to create the <a href="../../../../org/apache/iceberg/catalog/TableCommit.html" title="interface in org.apache.iceberg.catalog"><code>TableCommit</code></a> for.</dd>
<dd><code>base</code> - The base <a href="../../../../org/apache/iceberg/TableMetadata.html" title="class in org.apache.iceberg"><code>TableMetadata</code></a> where <a href="../../../../org/apache/iceberg/UpdateRequirement.html" title="interface in org.apache.iceberg"><code>UpdateRequirement</code></a>s are derived from
and used for validation.</dd>
<dd><code>updated</code> - The updated <a href="../../../../org/apache/iceberg/TableMetadata.html" title="class in org.apache.iceberg"><code>TableMetadata</code></a> where <a href="../../../../org/apache/iceberg/MetadataUpdate.html" title="interface in org.apache.iceberg"><code>MetadataUpdate</code></a>s that have been
applied are derived from.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A <a href="../../../../org/apache/iceberg/catalog/TableCommit.html" title="interface in org.apache.iceberg.catalog"><code>TableCommit</code></a> instance to be applied for a single table</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/catalog/SupportsNamespaces.html" title="interface in org.apache.iceberg.catalog"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/iceberg/catalog/TableIdentifier.html" title="class in org.apache.iceberg.catalog"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/iceberg/catalog/TableCommit.html" target="_top">Frames</a></li>
<li><a href="TableCommit.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>Constr&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>Constr&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>