blob: fad13265bc0f3504124a0bdbd1674cfa9e871a50 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>org.apache.iceberg.io</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="org.apache.iceberg.io";
}
}
catch(err) {
}
//-->
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 class="navBarCell1Rev">Package</li>
<li>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>
<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>
<main role="main">
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.iceberg.io</h1>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="CloseableIterable.html" title="interface in org.apache.iceberg.io">CloseableIterable</a>&lt;T&gt;</th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="CloseableIterator.html" title="interface in org.apache.iceberg.io">CloseableIterator</a>&lt;T&gt;</th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="CredentialSupplier.html" title="interface in org.apache.iceberg.io">CredentialSupplier</a></th>
<td class="colLast">
<div class="block">Interface used to expose credentials held by a FileIO instance.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="DelegatingInputStream.html" title="interface in org.apache.iceberg.io">DelegatingInputStream</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="DelegatingOutputStream.html" title="interface in org.apache.iceberg.io">DelegatingOutputStream</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="EqualityDeltaWriter.html" title="interface in org.apache.iceberg.io">EqualityDeltaWriter</a>&lt;T&gt;</th>
<td class="colLast">
<div class="block">A writer capable of writing data and equality deletes that may belong to different specs and partitions.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="FileAppender.html" title="interface in org.apache.iceberg.io">FileAppender</a>&lt;D&gt;</th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="FileAppenderFactory.html" title="interface in org.apache.iceberg.io">FileAppenderFactory</a>&lt;T&gt;</th>
<td class="colLast">
<div class="block">Factory to create a new <a href="FileAppender.html" title="interface in org.apache.iceberg.io"><code>FileAppender</code></a> to write records.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="FileIO.html" title="interface in org.apache.iceberg.io">FileIO</a></th>
<td class="colLast">
<div class="block">Pluggable module for reading, writing, and deleting files.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="FileIOMetricsContext.html" title="interface in org.apache.iceberg.io">FileIOMetricsContext</a></th>
<td class="colLast">
<div class="block">Extension of MetricsContext for use with FileIO to define standard metrics
that should be reported.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="FileWriter.html" title="interface in org.apache.iceberg.io">FileWriter</a>&lt;T,&#8203;R&gt;</th>
<td class="colLast">
<div class="block">A writer capable of writing files of a single type (i.e.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="FileWriterFactory.html" title="interface in org.apache.iceberg.io">FileWriterFactory</a>&lt;T&gt;</th>
<td class="colLast">
<div class="block">A factory for creating data and delete writers.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="InputFile.html" title="interface in org.apache.iceberg.io">InputFile</a></th>
<td class="colLast">
<div class="block">An interface used to read input files using <a href="SeekableInputStream.html" title="class in org.apache.iceberg.io"><code>SeekableInputStream</code></a> instances.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="LocationProvider.html" title="interface in org.apache.iceberg.io">LocationProvider</a></th>
<td class="colLast">
<div class="block">Interface for providing data file locations to write tasks.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="OutputFile.html" title="interface in org.apache.iceberg.io">OutputFile</a></th>
<td class="colLast">
<div class="block">An interface used to create output files using <a href="PositionOutputStream.html" title="class in org.apache.iceberg.io"><code>PositionOutputStream</code></a> instances.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="PartitioningWriter.html" title="interface in org.apache.iceberg.io">PartitioningWriter</a>&lt;T,&#8203;R&gt;</th>
<td class="colLast">
<div class="block">A writer capable of writing files of a single type (i.e.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="PositionDeltaWriter.html" title="interface in org.apache.iceberg.io">PositionDeltaWriter</a>&lt;T&gt;</th>
<td class="colLast">
<div class="block">A writer capable of writing data and position deletes that may belong to different specs and partitions.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="RangeReadable.html" title="interface in org.apache.iceberg.io">RangeReadable</a></th>
<td class="colLast">
<div class="block"><code>RangeReadable</code> is an interface that allows for implementations
of <a href="InputFile.html" title="interface in org.apache.iceberg.io"><code>InputFile</code></a> streams to perform positional, range-based reads, which
are more efficient than unbounded reads in many cloud provider object stores.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="SupportsBulkOperations.html" title="interface in org.apache.iceberg.io">SupportsBulkOperations</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="SupportsPrefixOperations.html" title="interface in org.apache.iceberg.io">SupportsPrefixOperations</a></th>
<td class="colLast">
<div class="block">This interface is intended as an extension for FileIO implementations
to provide additional prefix based operations that may be useful in
performing supporting operations.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="TaskWriter.html" title="interface in org.apache.iceberg.io">TaskWriter</a>&lt;T&gt;</th>
<td class="colLast">
<div class="block">The writer interface could accept records and provide the generated data files.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="BasePositionDeltaWriter.html" title="class in org.apache.iceberg.io">BasePositionDeltaWriter</a>&lt;T&gt;</th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="BaseTaskWriter.html" title="class in org.apache.iceberg.io">BaseTaskWriter</a>&lt;T&gt;</th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ByteBufferInputStream.html" title="class in org.apache.iceberg.io">ByteBufferInputStream</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="CloseableGroup.html" title="class in org.apache.iceberg.io">CloseableGroup</a></th>
<td class="colLast">
<div class="block">This class acts as a helper for handling the closure of multiple resource.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="CloseableIterable.ConcatCloseableIterable.html" title="class in org.apache.iceberg.io">CloseableIterable.ConcatCloseableIterable</a>&lt;E&gt;</th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ClosingIterator.html" title="class in org.apache.iceberg.io">ClosingIterator</a>&lt;T&gt;</th>
<td class="colLast">
<div class="block">A convenience wrapper around <a href="CloseableIterator.html" title="interface in org.apache.iceberg.io"><code>CloseableIterator</code></a>, providing auto-close
functionality when all of the elements in the iterator are consumed.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ClusteredDataWriter.html" title="class in org.apache.iceberg.io">ClusteredDataWriter</a>&lt;T&gt;</th>
<td class="colLast">
<div class="block">A data writer capable of writing to multiple specs and partitions that requires the incoming records
to be properly clustered by partition spec and by partition within each spec.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ClusteredEqualityDeleteWriter.html" title="class in org.apache.iceberg.io">ClusteredEqualityDeleteWriter</a>&lt;T&gt;</th>
<td class="colLast">
<div class="block">An equality delete writer capable of writing to multiple specs and partitions that requires
the incoming delete records to be properly clustered by partition spec and by partition within each spec.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ClusteredPositionDeleteWriter.html" title="class in org.apache.iceberg.io">ClusteredPositionDeleteWriter</a>&lt;T&gt;</th>
<td class="colLast">
<div class="block">A position delete writer capable of writing to multiple specs and partitions that requires
the incoming delete records to be properly clustered by partition spec and by partition within each spec.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="DataWriter.html" title="class in org.apache.iceberg.io">DataWriter</a>&lt;T&gt;</th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="DataWriteResult.html" title="class in org.apache.iceberg.io">DataWriteResult</a></th>
<td class="colLast">
<div class="block">A result of writing data files.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="DeleteSchemaUtil.html" title="class in org.apache.iceberg.io">DeleteSchemaUtil</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="DeleteWriteResult.html" title="class in org.apache.iceberg.io">DeleteWriteResult</a></th>
<td class="colLast">
<div class="block">A result of writing delete files.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="FanoutDataWriter.html" title="class in org.apache.iceberg.io">FanoutDataWriter</a>&lt;T&gt;</th>
<td class="colLast">
<div class="block">A data writer capable of writing to multiple specs and partitions that keeps data writers for each
seen spec/partition pair open until this writer is closed.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="FileInfo.html" title="class in org.apache.iceberg.io">FileInfo</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="FileIOParser.html" title="class in org.apache.iceberg.io">FileIOParser</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="FilterIterator.html" title="class in org.apache.iceberg.io">FilterIterator</a>&lt;T&gt;</th>
<td class="colLast">
<div class="block">An Iterator that filters another Iterator.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="IOUtil.html" title="class in org.apache.iceberg.io">IOUtil</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="OutputFileFactory.html" title="class in org.apache.iceberg.io">OutputFileFactory</a></th>
<td class="colLast">
<div class="block">Factory responsible for generating unique but recognizable data file names.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="OutputFileFactory.Builder.html" title="class in org.apache.iceberg.io">OutputFileFactory.Builder</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="PartitionedFanoutWriter.html" title="class in org.apache.iceberg.io">PartitionedFanoutWriter</a>&lt;T&gt;</th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="PartitionedWriter.html" title="class in org.apache.iceberg.io">PartitionedWriter</a>&lt;T&gt;</th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="PositionOutputStream.html" title="class in org.apache.iceberg.io">PositionOutputStream</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ResolvingFileIO.html" title="class in org.apache.iceberg.io">ResolvingFileIO</a></th>
<td class="colLast">
<div class="block">FileIO implementation that uses location scheme to choose the correct FileIO implementation.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="RollingDataWriter.html" title="class in org.apache.iceberg.io">RollingDataWriter</a>&lt;T&gt;</th>
<td class="colLast">
<div class="block">A rolling data writer that splits incoming data into multiple files within one spec/partition
based on the target file size.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="RollingEqualityDeleteWriter.html" title="class in org.apache.iceberg.io">RollingEqualityDeleteWriter</a>&lt;T&gt;</th>
<td class="colLast">
<div class="block">A rolling equality delete writer that splits incoming deletes into multiple files within one spec/partition
based on the target file size.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="RollingPositionDeleteWriter.html" title="class in org.apache.iceberg.io">RollingPositionDeleteWriter</a>&lt;T&gt;</th>
<td class="colLast">
<div class="block">A rolling position delete writer that splits incoming deletes into multiple files within one spec/partition
based on the target file size.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="SeekableInputStream.html" title="class in org.apache.iceberg.io">SeekableInputStream</a></th>
<td class="colLast">
<div class="block"><code>SeekableInputStream</code> is an interface with the methods needed to read data from a file or
Hadoop data stream.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="UnpartitionedWriter.html" title="class in org.apache.iceberg.io">UnpartitionedWriter</a>&lt;T&gt;</th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="WriteResult.html" title="class in org.apache.iceberg.io">WriteResult</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="WriteResult.Builder.html" title="class in org.apache.iceberg.io">WriteResult.Builder</a></th>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary">
<caption><span>Exception Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Exception</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="BulkDeletionFailureException.html" title="class in org.apache.iceberg.io">BulkDeletionFailureException</a></th>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
</main>
<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 class="navBarCell1Rev">Package</li>
<li>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>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
</body>
</html>