Google Git
Sign in
apache / orc / f303be55d00a7929d74b8bdad73a80554226901b / . / site / api / orc-core / org / apache / orc / package-summary.html
blob: ca2cbe99cfcea65cd7a8bc8f394636d10e7b407e [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 (1.8.0_252) on Sun Apr 26 20:47:06 PDT 2020 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>org.apache.orc (ORC Core 1.6.3 API)</title>
<meta name="date" content="2020-04-26">
<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="org.apache.orc (ORC Core 1.6.3 API)";
}
}
catch(err) {
}
//-->
</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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.html">Use</a></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="../../../io/airlift/slice/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../org/apache/orc/impl/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/apache/orc/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.orc</h1>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<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">
<td class="colFirst"><a href="../../../org/apache/orc/BinaryColumnStatistics.html" title="interface in org.apache.orc">BinaryColumnStatistics</a></td>
<td class="colLast">
<div class="block">Statistics for binary columns.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/apache/orc/BooleanColumnStatistics.html" title="interface in org.apache.orc">BooleanColumnStatistics</a></td>
<td class="colLast">
<div class="block">Statistics for boolean columns.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/apache/orc/CollectionColumnStatistics.html" title="interface in org.apache.orc">CollectionColumnStatistics</a></td>
<td class="colLast">
<div class="block">Statistics for all of collections such as Map and List.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/apache/orc/ColumnStatistics.html" title="interface in org.apache.orc">ColumnStatistics</a></td>
<td class="colLast">
<div class="block">Statistics that are available for all types of columns.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/apache/orc/CompressionCodec.html" title="interface in org.apache.orc">CompressionCodec</a></td>
<td class="colLast">
<div class="block">The API for compression codecs for ORC.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/apache/orc/CompressionCodec.Options.html" title="interface in org.apache.orc">CompressionCodec.Options</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/apache/orc/DataMask.html" title="interface in org.apache.orc">DataMask</a></td>
<td class="colLast">
<div class="block">The API for masking data during column encryption for ORC.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/apache/orc/DataMask.MaskOverrides.html" title="interface in org.apache.orc">DataMask.MaskOverrides</a></td>
<td class="colLast">
<div class="block">An interface to provide override data masks for sub-columns.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/apache/orc/DataMask.Provider.html" title="interface in org.apache.orc">DataMask.Provider</a></td>
<td class="colLast">
<div class="block">Providers can provide one or more kinds of data masks.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/apache/orc/DataMaskDescription.html" title="interface in org.apache.orc">DataMaskDescription</a></td>
<td class="colLast">
<div class="block">Information about the DataMask used to mask the unencrypted data.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/apache/orc/DataReader.html" title="interface in org.apache.orc">DataReader</a></td>
<td class="colLast">
<div class="block">An abstract data reader that IO formats can use to read bytes from underlying storage.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/apache/orc/DateColumnStatistics.html" title="interface in org.apache.orc">DateColumnStatistics</a></td>
<td class="colLast">
<div class="block">Statistics for DATE columns.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/apache/orc/DecimalColumnStatistics.html" title="interface in org.apache.orc">DecimalColumnStatistics</a></td>
<td class="colLast">
<div class="block">Statistics for decimal columns.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/apache/orc/DoubleColumnStatistics.html" title="interface in org.apache.orc">DoubleColumnStatistics</a></td>
<td class="colLast">
<div class="block">Statistics for float and double columns.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/apache/orc/EncryptionKey.html" title="interface in org.apache.orc">EncryptionKey</a></td>
<td class="colLast">
<div class="block">Information about a key used for column encryption in an ORC file.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/apache/orc/EncryptionVariant.html" title="interface in org.apache.orc">EncryptionVariant</a></td>
<td class="colLast">
<div class="block">Information about a column encryption variant.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/apache/orc/FileMetadata.html" title="interface in org.apache.orc">FileMetadata</a></td>
<td class="colLast">Deprecated
<div class="block"><span class="deprecationComment">Use <a href="../../../org/apache/orc/impl/OrcTail.html" title="class in org.apache.orc.impl"><code>OrcTail</code></a> instead</span></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/apache/orc/IntegerColumnStatistics.html" title="interface in org.apache.orc">IntegerColumnStatistics</a></td>
<td class="colLast">
<div class="block">Statistics for all of the integer columns, such as byte, short, int, and
long.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/apache/orc/MemoryManager.html" title="interface in org.apache.orc">MemoryManager</a></td>
<td class="colLast">
<div class="block">A memory manager that keeps a global context of how many ORC
writers there are and manages the memory between them.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/apache/orc/MemoryManager.Callback.html" title="interface in org.apache.orc">MemoryManager.Callback</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/apache/orc/OrcFile.WriterCallback.html" title="interface in org.apache.orc">OrcFile.WriterCallback</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/apache/orc/OrcFile.WriterContext.html" title="interface in org.apache.orc">OrcFile.WriterContext</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/apache/orc/PhysicalWriter.html" title="interface in org.apache.orc">PhysicalWriter</a></td>
<td class="colLast">
<div class="block">This interface separates the physical layout of ORC files from the higher
level details.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/apache/orc/PhysicalWriter.OutputReceiver.html" title="interface in org.apache.orc">PhysicalWriter.OutputReceiver</a></td>
<td class="colLast">
<div class="block">The target of an output stream.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/apache/orc/Reader.html" title="interface in org.apache.orc">Reader</a></td>
<td class="colLast">
<div class="block">The interface for reading ORC files.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/apache/orc/RecordReader.html" title="interface in org.apache.orc">RecordReader</a></td>
<td class="colLast">
<div class="block">A row-by-row iterator for ORC files.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/apache/orc/StringColumnStatistics.html" title="interface in org.apache.orc">StringColumnStatistics</a></td>
<td class="colLast">
<div class="block">Statistics for string columns.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/apache/orc/StripeInformation.html" title="interface in org.apache.orc">StripeInformation</a></td>
<td class="colLast">
<div class="block">Information about the stripes in an ORC file that is provided by the Reader.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/apache/orc/TimestampColumnStatistics.html" title="interface in org.apache.orc">TimestampColumnStatistics</a></td>
<td class="colLast">
<div class="block">Statistics for Timestamp columns.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/apache/orc/Writer.html" title="interface in org.apache.orc">Writer</a></td>
<td class="colLast">
<div class="block">The interface for writing ORC files.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<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">
<td class="colFirst"><a href="../../../org/apache/orc/DataMask.Factory.html" title="class in org.apache.orc">DataMask.Factory</a></td>
<td class="colLast">
<div class="block">To create a DataMask, the users should come through this API.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/apache/orc/InMemoryKeystore.html" title="class in org.apache.orc">InMemoryKeystore</a></td>
<td class="colLast">
<div class="block">This is an in-memory implementation of <a href="http://orc.apache.org/api/orc-core/org/apache/orc/impl/KeyProvider.html?is-external=true" title="class or interface in org.apache.orc.impl"><code>KeyProvider</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/apache/orc/OrcFile.html" title="class in org.apache.orc">OrcFile</a></td>
<td class="colLast">
<div class="block">Contains factory methods to read or write ORC files.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/apache/orc/OrcFile.ReaderOptions.html" title="class in org.apache.orc">OrcFile.ReaderOptions</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/apache/orc/OrcFile.WriterOptions.html" title="class in org.apache.orc">OrcFile.WriterOptions</a></td>
<td class="colLast">
<div class="block">Options for creating ORC file writers.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/apache/orc/OrcUtils.html" title="class in org.apache.orc">OrcUtils</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/apache/orc/Reader.Options.html" title="class in org.apache.orc">Reader.Options</a></td>
<td class="colLast">
<div class="block">Options for creating a RecordReader.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/apache/orc/StripeStatistics.html" title="class in org.apache.orc">StripeStatistics</a></td>
<td class="colLast">
<div class="block">The statistics for a stripe.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/apache/orc/TypeDescription.html" title="class in org.apache.orc">TypeDescription</a></td>
<td class="colLast">
<div class="block">This is the description of the types in an ORC file.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/apache/orc/TypeDescriptionPrettyPrint.html" title="class in org.apache.orc">TypeDescriptionPrettyPrint</a></td>
<td class="colLast">
<div class="block">A pretty printer for TypeDescription.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation">
<caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/apache/orc/CompressionCodec.DataKind.html" title="enum in org.apache.orc">CompressionCodec.DataKind</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/apache/orc/CompressionCodec.SpeedModifier.html" title="enum in org.apache.orc">CompressionCodec.SpeedModifier</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/apache/orc/CompressionKind.html" title="enum in org.apache.orc">CompressionKind</a></td>
<td class="colLast">
<div class="block">An enumeration that lists the generic compression algorithms that
can be applied to ORC files.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/apache/orc/DataMask.Standard.html" title="enum in org.apache.orc">DataMask.Standard</a></td>
<td class="colLast">
<div class="block">The standard DataMasks can be created using this short cut.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/apache/orc/OrcConf.html" title="enum in org.apache.orc">OrcConf</a></td>
<td class="colLast">
<div class="block">Define the configuration properties that Orc understands.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/apache/orc/OrcFile.BloomFilterVersion.html" title="enum in org.apache.orc">OrcFile.BloomFilterVersion</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/apache/orc/OrcFile.CompressionStrategy.html" title="enum in org.apache.orc">OrcFile.CompressionStrategy</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/apache/orc/OrcFile.EncodingStrategy.html" title="enum in org.apache.orc">OrcFile.EncodingStrategy</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/apache/orc/OrcFile.Version.html" title="enum in org.apache.orc">OrcFile.Version</a></td>
<td class="colLast">
<div class="block">Create a version number for the ORC file format, so that we can add
non-forward compatible changes in the future.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/apache/orc/OrcFile.WriterImplementation.html" title="enum in org.apache.orc">OrcFile.WriterImplementation</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/apache/orc/OrcFile.WriterVersion.html" title="enum in org.apache.orc">OrcFile.WriterVersion</a></td>
<td class="colLast">
<div class="block">Records the version of the writer in terms of which bugs have been fixed.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/apache/orc/TypeDescription.Category.html" title="enum in org.apache.orc">TypeDescription.Category</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../org/apache/orc/TypeDescription.RowBatchVersion.html" title="enum in org.apache.orc">TypeDescription.RowBatchVersion</a></td>
<td class="colLast">
<div class="block">Specify the version of the VectorizedRowBatch that the user desires.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation">
<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">
<td class="colFirst"><a href="../../../org/apache/orc/FileFormatException.html" title="class in org.apache.orc">FileFormatException</a></td>
<td class="colLast">
<div class="block">Thrown when an invalid file format is encountered.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../org/apache/orc/UnknownFormatException.html" title="class in org.apache.orc">UnknownFormatException</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
<!-- ======= 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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.html">Use</a></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="../../../io/airlift/slice/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../org/apache/orc/impl/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/apache/orc/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2013&#x2013;2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>