blob: 51f07de7109f68f17f6a1a748a73b6f5ef91b6ca [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>TableCommit</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.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.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.6.1.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-ui.min.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="TableCommit";
}
}
catch(err) {
}
//-->
var data = {"i0":1,"i1":6,"i2":6,"i3":6};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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>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 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.catalog</a></div>
<h2 title="Interface TableCommit" class="title">Interface TableCommit</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>@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="../UpdateRequirement.html" title="interface in org.apache.iceberg"><code>UpdateRequirement</code></a>s to be
validated and <a href="../MetadataUpdate.html" title="interface in org.apache.iceberg"><code>MetadataUpdate</code></a>s that have been applied. The <a href="../UpdateRequirement.html" title="interface in org.apache.iceberg"><code>UpdateRequirement</code></a>s and
<a href="../MetadataUpdate.html" title="interface in org.apache.iceberg"><code>MetadataUpdate</code></a>s can be derived from table's base and updated <a href="../TableMetadata.html" title="class in org.apache.iceberg"><code>TableMetadata</code></a> when
using <a href="#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 =========== -->
<section>
<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="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></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>static <a href="TableCommit.html" title="interface in org.apache.iceberg.catalog">TableCommit</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#create(org.apache.iceberg.catalog.TableIdentifier,org.apache.iceberg.TableMetadata,org.apache.iceberg.TableMetadata)">create</a></span>&#8203;(<a href="TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a>&nbsp;identifier,
<a href="../TableMetadata.html" title="class in org.apache.iceberg">TableMetadata</a>&nbsp;base,
<a href="../TableMetadata.html" title="class in org.apache.iceberg">TableMetadata</a>&nbsp;updated)</code></th>
<td class="colLast">
<div class="block">This creates a <a href="TableCommit.html" title="interface in org.apache.iceberg.catalog"><code>TableCommit</code></a> instance to be applied for a single table with <a href="../UpdateRequirement.html" title="interface in org.apache.iceberg"><code>UpdateRequirement</code></a>s to be validated and <a href="../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="TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#identifier()">identifier</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../UpdateRequirement.html" title="interface in org.apache.iceberg">UpdateRequirement</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#requirements()">requirements</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../MetadataUpdate.html" title="interface in org.apache.iceberg">MetadataUpdate</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#updates()">updates</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="identifier()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>identifier</h4>
<pre class="methodSignature"><a href="TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a>&nbsp;identifier()</pre>
</li>
</ul>
<a id="requirements()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>requirements</h4>
<pre class="methodSignature">java.util.List&lt;<a href="../UpdateRequirement.html" title="interface in org.apache.iceberg">UpdateRequirement</a>&gt;&nbsp;requirements()</pre>
</li>
</ul>
<a id="updates()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updates</h4>
<pre class="methodSignature">java.util.List&lt;<a href="../MetadataUpdate.html" title="interface in org.apache.iceberg">MetadataUpdate</a>&gt;&nbsp;updates()</pre>
</li>
</ul>
<a id="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 class="methodSignature">static&nbsp;<a href="TableCommit.html" title="interface in org.apache.iceberg.catalog">TableCommit</a>&nbsp;create&#8203;(<a href="TableIdentifier.html" title="class in org.apache.iceberg.catalog">TableIdentifier</a>&nbsp;identifier,
<a href="../TableMetadata.html" title="class in org.apache.iceberg">TableMetadata</a>&nbsp;base,
<a href="../TableMetadata.html" title="class in org.apache.iceberg">TableMetadata</a>&nbsp;updated)</pre>
<div class="block">This creates a <a href="TableCommit.html" title="interface in org.apache.iceberg.catalog"><code>TableCommit</code></a> instance to be applied for a single table with <a href="../UpdateRequirement.html" title="interface in org.apache.iceberg"><code>UpdateRequirement</code></a>s to be validated and <a href="../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="TableIdentifier.html" title="class in org.apache.iceberg.catalog"><code>TableIdentifier</code></a> to create the <a href="TableCommit.html" title="interface in org.apache.iceberg.catalog"><code>TableCommit</code></a> for.</dd>
<dd><code>base</code> - The base <a href="../TableMetadata.html" title="class in org.apache.iceberg"><code>TableMetadata</code></a> where <a href="../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="../TableMetadata.html" title="class in org.apache.iceberg"><code>TableMetadata</code></a> where <a href="../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="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>
</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>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 id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
</body>
</html>