blob: 6cc09409f37aa035d32f78578a0bf5803dbb7db9 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.12) on Wed Aug 18 10:34:26 PDT 2021 -->
<title>HiveIcebergOutputCommitter</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2021-08-18">
<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="HiveIcebergOutputCommitter";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":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.mr.hive</a></div>
<h2 title="Class HiveIcebergOutputCommitter" class="title">Class HiveIcebergOutputCommitter</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.hadoop.mapreduce.OutputCommitter</li>
<li>
<ul class="inheritance">
<li>org.apache.hadoop.mapred.OutputCommitter</li>
<li>
<ul class="inheritance">
<li>org.apache.iceberg.mr.hive.HiveIcebergOutputCommitter</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>public class <span class="typeNameLabel">HiveIcebergOutputCommitter</span>
extends org.apache.hadoop.mapred.OutputCommitter</pre>
<div class="block">An Iceberg table committer for adding data files to the Iceberg tables.
Currently independent of the Hive ACID transactions.</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()">HiveIcebergOutputCommitter</a></span>()</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="#abortJob(org.apache.hadoop.mapred.JobContext,int)">abortJob</a></span>&#8203;(org.apache.hadoop.mapred.JobContext&nbsp;originalContext,
int&nbsp;status)</code></th>
<td class="colLast">
<div class="block">Removes the generated data files if there is a commit file already generated for them.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#abortTask(org.apache.hadoop.mapred.TaskAttemptContext)">abortTask</a></span>&#8203;(org.apache.hadoop.mapred.TaskAttemptContext&nbsp;originalContext)</code></th>
<td class="colLast">
<div class="block">Removes files generated by this task.</div>
</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="#commitJob(org.apache.hadoop.mapred.JobContext)">commitJob</a></span>&#8203;(org.apache.hadoop.mapred.JobContext&nbsp;originalContext)</code></th>
<td class="colLast">
<div class="block">Reads the commit files stored in the temp directories and collects the generated committed data files.</div>
</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="#commitTask(org.apache.hadoop.mapred.TaskAttemptContext)">commitTask</a></span>&#8203;(org.apache.hadoop.mapred.TaskAttemptContext&nbsp;originalContext)</code></th>
<td class="colLast">
<div class="block">Collects the generated data files and creates a commit file storing the data file list.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#needsTaskCommit(org.apache.hadoop.mapred.TaskAttemptContext)">needsTaskCommit</a></span>&#8203;(org.apache.hadoop.mapred.TaskAttemptContext&nbsp;context)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setupJob(org.apache.hadoop.mapred.JobContext)">setupJob</a></span>&#8203;(org.apache.hadoop.mapred.JobContext&nbsp;jobContext)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setupTask(org.apache.hadoop.mapred.TaskAttemptContext)">setupTask</a></span>&#8203;(org.apache.hadoop.mapred.TaskAttemptContext&nbsp;taskAttemptContext)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.hadoop.mapred.OutputCommitter">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.hadoop.mapred.OutputCommitter</h3>
<code>abortJob, abortTask, cleanupJob, cleanupJob, commitJob, commitTask, isCommitJobRepeatable, isCommitJobRepeatable, isRecoverySupported, isRecoverySupported, isRecoverySupported, needsTaskCommit, recoverTask, recoverTask, setupJob, setupTask</code></li>
</ul>
<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>
</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;()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>HiveIcebergOutputCommitter</h4>
<pre>public&nbsp;HiveIcebergOutputCommitter()</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="setupJob(org.apache.hadoop.mapred.JobContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setupJob</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setupJob&#8203;(org.apache.hadoop.mapred.JobContext&nbsp;jobContext)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>setupJob</code>&nbsp;in class&nbsp;<code>org.apache.hadoop.mapred.OutputCommitter</code></dd>
</dl>
</li>
</ul>
<a id="setupTask(org.apache.hadoop.mapred.TaskAttemptContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setupTask</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setupTask&#8203;(org.apache.hadoop.mapred.TaskAttemptContext&nbsp;taskAttemptContext)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>setupTask</code>&nbsp;in class&nbsp;<code>org.apache.hadoop.mapred.OutputCommitter</code></dd>
</dl>
</li>
</ul>
<a id="needsTaskCommit(org.apache.hadoop.mapred.TaskAttemptContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>needsTaskCommit</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;needsTaskCommit&#8203;(org.apache.hadoop.mapred.TaskAttemptContext&nbsp;context)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>needsTaskCommit</code>&nbsp;in class&nbsp;<code>org.apache.hadoop.mapred.OutputCommitter</code></dd>
</dl>
</li>
</ul>
<a id="commitTask(org.apache.hadoop.mapred.TaskAttemptContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>commitTask</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;commitTask&#8203;(org.apache.hadoop.mapred.TaskAttemptContext&nbsp;originalContext)
throws java.io.IOException</pre>
<div class="block">Collects the generated data files and creates a commit file storing the data file list.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>commitTask</code>&nbsp;in class&nbsp;<code>org.apache.hadoop.mapred.OutputCommitter</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>originalContext</code> - The task attempt context</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - Thrown if there is an error writing the commit file</dd>
</dl>
</li>
</ul>
<a id="abortTask(org.apache.hadoop.mapred.TaskAttemptContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>abortTask</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;abortTask&#8203;(org.apache.hadoop.mapred.TaskAttemptContext&nbsp;originalContext)
throws java.io.IOException</pre>
<div class="block">Removes files generated by this task.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>abortTask</code>&nbsp;in class&nbsp;<code>org.apache.hadoop.mapred.OutputCommitter</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>originalContext</code> - The task attempt context</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - Thrown if there is an error closing the writer</dd>
</dl>
</li>
</ul>
<a id="commitJob(org.apache.hadoop.mapred.JobContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>commitJob</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;commitJob&#8203;(org.apache.hadoop.mapred.JobContext&nbsp;originalContext)
throws java.io.IOException</pre>
<div class="block">Reads the commit files stored in the temp directories and collects the generated committed data files.
Appends the data files to the tables. At the end removes the temporary directories.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>commitJob</code>&nbsp;in class&nbsp;<code>org.apache.hadoop.mapred.OutputCommitter</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>originalContext</code> - The job context</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if there is a failure accessing the files</dd>
</dl>
</li>
</ul>
<a id="abortJob(org.apache.hadoop.mapred.JobContext,int)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>abortJob</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;abortJob&#8203;(org.apache.hadoop.mapred.JobContext&nbsp;originalContext,
int&nbsp;status)
throws java.io.IOException</pre>
<div class="block">Removes the generated data files if there is a commit file already generated for them.
The cleanup at the end removes the temporary directories as well.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>abortJob</code>&nbsp;in class&nbsp;<code>org.apache.hadoop.mapred.OutputCommitter</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>originalContext</code> - The job context</dd>
<dd><code>status</code> - The status of the job</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if there is a failure deleting the files</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>