blob: 1d3a5ffd8c022b4ac60c064a8565677238bbddc5 [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:05 PDT 2020 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>WriterImplV2 (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="WriterImplV2 (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><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/WriterImplV2.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="../../../../../org/apache/orc/impl/writer/WriterEncryptionVariant.html" title="class in org.apache.orc.impl.writer"><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/orc/impl/writer/WriterImplV2.html" target="_top">Frames</a></li>
<li><a href="WriterImplV2.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><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#methods.inherited.from.class.org.apache.orc.impl.WriterImpl">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>Method</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.orc.impl.writer</div>
<h2 title="Class WriterImplV2" class="title">Class WriterImplV2</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/orc/impl/WriterImpl.html" title="class in org.apache.orc.impl">org.apache.orc.impl.WriterImpl</a></li>
<li>
<ul class="inheritance">
<li>org.apache.orc.impl.writer.WriterImplV2</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="http://docs.oracle.com/javase/8/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a>, <a href="../../../../../org/apache/orc/impl/WriterInternal.html" title="interface in org.apache.orc.impl">WriterInternal</a>, <a href="../../../../../org/apache/orc/MemoryManager.Callback.html" title="interface in org.apache.orc">MemoryManager.Callback</a>, <a href="../../../../../org/apache/orc/Writer.html" title="interface in org.apache.orc">Writer</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">WriterImplV2</span>
extends <a href="../../../../../org/apache/orc/impl/WriterImpl.html" title="class in org.apache.orc.impl">WriterImpl</a></pre>
<div class="block">An ORCv2 file writer. The file is divided into stripes, which is the natural
unit of work when reading. Each stripe is buffered in memory until the
memory reaches the stripe size and then it is written out broken down by
columns. Each column is written by a TreeWriter that is specific to that
type of column. TreeWriters may have children TreeWriters that handle the
sub-types. Each of the TreeWriters writes the column's data as a set of
streams.
This class is unsynchronized like most Stream objects, so from the creation
of an OrcFile and all access to a single instance has to be from a single
thread.
There are no known cases where these happen between different threads today.
Caveat: the MemoryManager is created during WriterOptions create, that has
to be confined to a single thread as well.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/orc/impl/writer/WriterImplV2.html#WriterImplV2-org.apache.hadoop.fs.FileSystem-org.apache.hadoop.fs.Path-org.apache.orc.OrcFile.WriterOptions-">WriterImplV2</a></span>(<a href="http://hadoop.apache.org/docs/r2.7.3/api/org/apache/hadoop/fs/FileSystem.html?is-external=true" title="class or interface in org.apache.hadoop.fs">FileSystem</a>&nbsp;fs,
<a href="http://hadoop.apache.org/docs/r2.7.3/api/org/apache/hadoop/fs/Path.html?is-external=true" title="class or interface in org.apache.hadoop.fs">Path</a>&nbsp;path,
<a href="../../../../../org/apache/orc/OrcFile.WriterOptions.html" title="class in org.apache.orc">OrcFile.WriterOptions</a>&nbsp;opts)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.orc.impl.WriterImpl">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.orc.impl.<a href="../../../../../org/apache/orc/impl/WriterImpl.html" title="class in org.apache.orc.impl">WriterImpl</a></h3>
<code><a href="../../../../../org/apache/orc/impl/WriterImpl.html#addRowBatch-org.apache.hadoop.hive.ql.exec.vector.VectorizedRowBatch-">addRowBatch</a>, <a href="../../../../../org/apache/orc/impl/WriterImpl.html#addUserMetadata-java.lang.String-java.nio.ByteBuffer-">addUserMetadata</a>, <a href="../../../../../org/apache/orc/impl/WriterImpl.html#appendStripe-byte:A-int-int-org.apache.orc.StripeInformation-org.apache.orc.OrcProto.StripeStatistics-">appendStripe</a>, <a href="../../../../../org/apache/orc/impl/WriterImpl.html#appendStripe-byte:A-int-int-org.apache.orc.StripeInformation-org.apache.orc.StripeStatistics:A-">appendStripe</a>, <a href="../../../../../org/apache/orc/impl/WriterImpl.html#appendUserMetadata-java.util.List-">appendUserMetadata</a>, <a href="../../../../../org/apache/orc/impl/WriterImpl.html#checkMemory-double-">checkMemory</a>, <a href="../../../../../org/apache/orc/impl/WriterImpl.html#close--">close</a>, <a href="../../../../../org/apache/orc/impl/WriterImpl.html#createCodec-org.apache.orc.CompressionKind-">createCodec</a>, <a href="../../../../../org/apache/orc/impl/WriterImpl.html#getCompressionCodec--">getCompressionCodec</a>, <a href="../../../../../org/apache/orc/impl/WriterImpl.html#getEstimatedBufferSize-long-int-int-">getEstimatedBufferSize</a>, <a href="../../../../../org/apache/orc/impl/WriterImpl.html#getNumberOfRows--">getNumberOfRows</a>, <a href="../../../../../org/apache/orc/impl/WriterImpl.html#getRawDataSize--">getRawDataSize</a>, <a href="../../../../../org/apache/orc/impl/WriterImpl.html#getSchema--">getSchema</a>, <a href="../../../../../org/apache/orc/impl/WriterImpl.html#getStatistics--">getStatistics</a>, <a href="../../../../../org/apache/orc/impl/WriterImpl.html#increaseCompressionSize-int-">increaseCompressionSize</a>, <a href="../../../../../org/apache/orc/impl/WriterImpl.html#writeIntermediateFooter--">writeIntermediateFooter</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="WriterImplV2-org.apache.hadoop.fs.FileSystem-org.apache.hadoop.fs.Path-org.apache.orc.OrcFile.WriterOptions-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>WriterImplV2</h4>
<pre>public&nbsp;WriterImplV2(<a href="http://hadoop.apache.org/docs/r2.7.3/api/org/apache/hadoop/fs/FileSystem.html?is-external=true" title="class or interface in org.apache.hadoop.fs">FileSystem</a>&nbsp;fs,
<a href="http://hadoop.apache.org/docs/r2.7.3/api/org/apache/hadoop/fs/Path.html?is-external=true" title="class or interface in org.apache.hadoop.fs">Path</a>&nbsp;path,
<a href="../../../../../org/apache/orc/OrcFile.WriterOptions.html" title="class in org.apache.orc">OrcFile.WriterOptions</a>&nbsp;opts)
throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</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="class-use/WriterImplV2.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="../../../../../org/apache/orc/impl/writer/WriterEncryptionVariant.html" title="class in org.apache.orc.impl.writer"><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/orc/impl/writer/WriterImplV2.html" target="_top">Frames</a></li>
<li><a href="WriterImplV2.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><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#methods.inherited.from.class.org.apache.orc.impl.WriterImpl">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>Method</li>
</ul>
</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>