blob: 928c20a81bd7dbc5f01a423b59a726aa26cd8224 [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>SupportsDelta</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="SupportsDelta";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/spark/sql/connector/iceberg/write/RowLevelOperationInfo.html" title="interface in org.apache.spark.sql.connector.iceberg.write"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/spark/sql/connector/iceberg/write/SupportsDelta.html" target="_top">Frames</a></li>
<li><a href="SupportsDelta.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.spark.sql.connector.iceberg.write</div>
<h2 title="Interface SupportsDelta" class="title">Interface SupportsDelta</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../../../../org/apache/spark/sql/connector/iceberg/write/RowLevelOperation.html" title="interface in org.apache.spark.sql.connector.iceberg.write">RowLevelOperation</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">SupportsDelta</span>
extends <a href="../../../../../../../org/apache/spark/sql/connector/iceberg/write/RowLevelOperation.html" title="interface in org.apache.spark.sql.connector.iceberg.write">RowLevelOperation</a></pre>
<div class="block">A mix-in interface for RowLevelOperation. Data sources can implement this interface
to indicate they support handling deltas of rows.</div>
</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>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.spark.sql.connector.iceberg.write.RowLevelOperation">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.apache.spark.sql.connector.iceberg.write.<a href="../../../../../../../org/apache/spark/sql/connector/iceberg/write/RowLevelOperation.html" title="interface in org.apache.spark.sql.connector.iceberg.write">RowLevelOperation</a></h3>
<code><a href="../../../../../../../org/apache/spark/sql/connector/iceberg/write/RowLevelOperation.Command.html" title="enum in org.apache.spark.sql.connector.iceberg.write">RowLevelOperation.Command</a></code></li>
</ul>
</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="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="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/spark/sql/connector/iceberg/write/DeltaWriteBuilder.html" title="interface in org.apache.spark.sql.connector.iceberg.write">DeltaWriteBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/spark/sql/connector/iceberg/write/SupportsDelta.html#newWriteBuilder-org.apache.spark.sql.connector.iceberg.write.ExtendedLogicalWriteInfo-">newWriteBuilder</a></span>(<a href="../../../../../../../org/apache/spark/sql/connector/iceberg/write/ExtendedLogicalWriteInfo.html" title="interface in org.apache.spark.sql.connector.iceberg.write">ExtendedLogicalWriteInfo</a>&nbsp;info)</code>
<div class="block">Returns a write builder to configure a write for this row-level operation.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>org.apache.spark.sql.connector.expressions.NamedReference[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/spark/sql/connector/iceberg/write/SupportsDelta.html#rowId--">rowId</a></span>()</code>
<div class="block">Returns the row ID column references that should be used for row equality.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.spark.sql.connector.iceberg.write.RowLevelOperation">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.spark.sql.connector.iceberg.write.<a href="../../../../../../../org/apache/spark/sql/connector/iceberg/write/RowLevelOperation.html" title="interface in org.apache.spark.sql.connector.iceberg.write">RowLevelOperation</a></h3>
<code><a href="../../../../../../../org/apache/spark/sql/connector/iceberg/write/RowLevelOperation.html#command--">command</a>, <a href="../../../../../../../org/apache/spark/sql/connector/iceberg/write/RowLevelOperation.html#description--">description</a>, <a href="../../../../../../../org/apache/spark/sql/connector/iceberg/write/RowLevelOperation.html#newScanBuilder-org.apache.spark.sql.util.CaseInsensitiveStringMap-">newScanBuilder</a>, <a href="../../../../../../../org/apache/spark/sql/connector/iceberg/write/RowLevelOperation.html#requiredMetadataAttributes--">requiredMetadataAttributes</a></code></li>
</ul>
</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="newWriteBuilder-org.apache.spark.sql.connector.iceberg.write.ExtendedLogicalWriteInfo-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newWriteBuilder</h4>
<pre><a href="../../../../../../../org/apache/spark/sql/connector/iceberg/write/DeltaWriteBuilder.html" title="interface in org.apache.spark.sql.connector.iceberg.write">DeltaWriteBuilder</a>&nbsp;newWriteBuilder(<a href="../../../../../../../org/apache/spark/sql/connector/iceberg/write/ExtendedLogicalWriteInfo.html" title="interface in org.apache.spark.sql.connector.iceberg.write">ExtendedLogicalWriteInfo</a>&nbsp;info)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../org/apache/spark/sql/connector/iceberg/write/RowLevelOperation.html#newWriteBuilder-org.apache.spark.sql.connector.iceberg.write.ExtendedLogicalWriteInfo-">RowLevelOperation</a></code></span></div>
<div class="block">Returns a write builder to configure a write for this row-level operation.
<p>
Note that Spark will first configure the scan and then the write, allowing data sources
to pass information from the scan to the write. For example, the scan can report
which condition was used to read the data that may be needed by the write under certain
isolation levels.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/spark/sql/connector/iceberg/write/RowLevelOperation.html#newWriteBuilder-org.apache.spark.sql.connector.iceberg.write.ExtendedLogicalWriteInfo-">newWriteBuilder</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/apache/spark/sql/connector/iceberg/write/RowLevelOperation.html" title="interface in org.apache.spark.sql.connector.iceberg.write">RowLevelOperation</a></code></dd>
</dl>
</li>
</ul>
<a name="rowId--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>rowId</h4>
<pre>org.apache.spark.sql.connector.expressions.NamedReference[]&nbsp;rowId()</pre>
<div class="block">Returns the row ID column references that should be used for row equality.</div>
</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/spark/sql/connector/iceberg/write/RowLevelOperationInfo.html" title="interface in org.apache.spark.sql.connector.iceberg.write"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/spark/sql/connector/iceberg/write/SupportsDelta.html" target="_top">Frames</a></li>
<li><a href="SupportsDelta.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>