| <!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>OrcFile (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="OrcFile (ORC Core 1.6.3 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete 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="class-use/OrcFile.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/OrcConf.html" title="enum in org.apache.orc"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../org/apache/orc/OrcFile.BloomFilterVersion.html" title="enum in org.apache.orc"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?org/apache/orc/OrcFile.html" target="_top">Frames</a></li> |
| <li><a href="OrcFile.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../allclasses-noframe.html">All 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: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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.orc</div> |
| <h2 title="Class OrcFile" class="title">Class OrcFile</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>org.apache.orc.OrcFile</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">OrcFile</span> |
| extends <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></pre> |
| <div class="block">Contains factory methods to read or write ORC files.</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> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/orc/OrcFile.BloomFilterVersion.html" title="enum in org.apache.orc">OrcFile.BloomFilterVersion</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/orc/OrcFile.CompressionStrategy.html" title="enum in org.apache.orc">OrcFile.CompressionStrategy</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/orc/OrcFile.EncodingStrategy.html" title="enum in org.apache.orc">OrcFile.EncodingStrategy</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/orc/OrcFile.ReaderOptions.html" title="class in org.apache.orc">OrcFile.ReaderOptions</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/orc/OrcFile.Version.html" title="enum in org.apache.orc">OrcFile.Version</a></span></code> |
| <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"><code>static interface </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/orc/OrcFile.WriterCallback.html" title="interface in org.apache.orc">OrcFile.WriterCallback</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static interface </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/orc/OrcFile.WriterContext.html" title="interface in org.apache.orc">OrcFile.WriterContext</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/orc/OrcFile.WriterImplementation.html" title="enum in org.apache.orc">OrcFile.WriterImplementation</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/orc/OrcFile.WriterOptions.html" title="class in org.apache.orc">OrcFile.WriterOptions</a></span></code> |
| <div class="block">Options for creating ORC file writers.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/orc/OrcFile.WriterVersion.html" title="enum in org.apache.orc">OrcFile.WriterVersion</a></span></code> |
| <div class="block">Records the version of the writer in terms of which bugs have been fixed.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../org/apache/orc/OrcFile.WriterVersion.html" title="enum in org.apache.orc">OrcFile.WriterVersion</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/orc/OrcFile.html#CURRENT_WRITER">CURRENT_WRITER</a></span></code> |
| <div class="block">The WriterVersion for this version of the software.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/orc/OrcFile.html#MAGIC">MAGIC</a></span></code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== 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"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier</th> |
| <th class="colLast" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/orc/OrcFile.html#OrcFile--">OrcFile</a></span>()</code> </td> |
| </tr> |
| </table> |
| </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"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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>static <a href="../../../org/apache/orc/Reader.html" title="interface in org.apache.orc">Reader</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/orc/OrcFile.html#createReader-org.apache.hadoop.fs.Path-org.apache.orc.OrcFile.ReaderOptions-">createReader</a></span>(<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> path, |
| <a href="../../../org/apache/orc/OrcFile.ReaderOptions.html" title="class in org.apache.orc">OrcFile.ReaderOptions</a> options)</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../org/apache/orc/Writer.html" title="interface in org.apache.orc">Writer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/orc/OrcFile.html#createWriter-org.apache.hadoop.fs.Path-org.apache.orc.OrcFile.WriterOptions-">createWriter</a></span>(<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> path, |
| <a href="../../../org/apache/orc/OrcFile.WriterOptions.html" title="class in org.apache.orc">OrcFile.WriterOptions</a> opts)</code> |
| <div class="block">Create an ORC file writer.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<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>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/orc/OrcFile.html#mergeFiles-org.apache.hadoop.fs.Path-org.apache.orc.OrcFile.WriterOptions-java.util.List-">mergeFiles</a></span>(<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> outputPath, |
| <a href="../../../org/apache/orc/OrcFile.WriterOptions.html" title="class in org.apache.orc">OrcFile.WriterOptions</a> options, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<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>> inputFiles)</code> |
| <div class="block">Merges multiple ORC files that all have the same schema to produce |
| a single ORC file.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../org/apache/orc/OrcFile.ReaderOptions.html" title="class in org.apache.orc">OrcFile.ReaderOptions</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/orc/OrcFile.html#readerOptions-org.apache.hadoop.conf.Configuration-">readerOptions</a></span>(<a href="http://hadoop.apache.org/docs/r2.7.3/api/org/apache/hadoop/conf/Configuration.html?is-external=true" title="class or interface in org.apache.hadoop.conf">Configuration</a> conf)</code> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../org/apache/orc/OrcFile.WriterOptions.html" title="class in org.apache.orc">OrcFile.WriterOptions</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/orc/OrcFile.html#writerOptions-org.apache.hadoop.conf.Configuration-">writerOptions</a></span>(<a href="http://hadoop.apache.org/docs/r2.7.3/api/org/apache/hadoop/conf/Configuration.html?is-external=true" title="class or interface in org.apache.hadoop.conf">Configuration</a> conf)</code> |
| <div class="block">Create a set of writer options based on a configuration.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../org/apache/orc/OrcFile.WriterOptions.html" title="class in org.apache.orc">OrcFile.WriterOptions</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/orc/OrcFile.html#writerOptions-java.util.Properties-org.apache.hadoop.conf.Configuration-">writerOptions</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a> tableProperties, |
| <a href="http://hadoop.apache.org/docs/r2.7.3/api/org/apache/hadoop/conf/Configuration.html?is-external=true" title="class or interface in org.apache.hadoop.conf">Configuration</a> conf)</code> |
| <div class="block">Create a set of write options based on a set of table properties and |
| configuration.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class 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"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="MAGIC"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>MAGIC</h4> |
| <pre>public static final <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> MAGIC</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../constant-values.html#org.apache.orc.OrcFile.MAGIC">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="CURRENT_WRITER"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>CURRENT_WRITER</h4> |
| <pre>public static final <a href="../../../org/apache/orc/OrcFile.WriterVersion.html" title="enum in org.apache.orc">OrcFile.WriterVersion</a> CURRENT_WRITER</pre> |
| <div class="block">The WriterVersion for this version of the software.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="OrcFile--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>OrcFile</h4> |
| <pre>protected OrcFile()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="readerOptions-org.apache.hadoop.conf.Configuration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readerOptions</h4> |
| <pre>public static <a href="../../../org/apache/orc/OrcFile.ReaderOptions.html" title="class in org.apache.orc">OrcFile.ReaderOptions</a> readerOptions(<a href="http://hadoop.apache.org/docs/r2.7.3/api/org/apache/hadoop/conf/Configuration.html?is-external=true" title="class or interface in org.apache.hadoop.conf">Configuration</a> conf)</pre> |
| </li> |
| </ul> |
| <a name="createReader-org.apache.hadoop.fs.Path-org.apache.orc.OrcFile.ReaderOptions-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createReader</h4> |
| <pre>public static <a href="../../../org/apache/orc/Reader.html" title="interface in org.apache.orc">Reader</a> createReader(<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> path, |
| <a href="../../../org/apache/orc/OrcFile.ReaderOptions.html" title="class in org.apache.orc">OrcFile.ReaderOptions</a> options) |
| 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> |
| <a name="writerOptions-org.apache.hadoop.conf.Configuration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writerOptions</h4> |
| <pre>public static <a href="../../../org/apache/orc/OrcFile.WriterOptions.html" title="class in org.apache.orc">OrcFile.WriterOptions</a> writerOptions(<a href="http://hadoop.apache.org/docs/r2.7.3/api/org/apache/hadoop/conf/Configuration.html?is-external=true" title="class or interface in org.apache.hadoop.conf">Configuration</a> conf)</pre> |
| <div class="block">Create a set of writer options based on a configuration.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>conf</code> - the configuration to use for values</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A WriterOptions object that can be modified</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="writerOptions-java.util.Properties-org.apache.hadoop.conf.Configuration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writerOptions</h4> |
| <pre>public static <a href="../../../org/apache/orc/OrcFile.WriterOptions.html" title="class in org.apache.orc">OrcFile.WriterOptions</a> writerOptions(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a> tableProperties, |
| <a href="http://hadoop.apache.org/docs/r2.7.3/api/org/apache/hadoop/conf/Configuration.html?is-external=true" title="class or interface in org.apache.hadoop.conf">Configuration</a> conf)</pre> |
| <div class="block">Create a set of write options based on a set of table properties and |
| configuration.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>tableProperties</code> - the properties of the table</dd> |
| <dd><code>conf</code> - the configuration of the query</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a WriterOptions object that can be modified</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createWriter-org.apache.hadoop.fs.Path-org.apache.orc.OrcFile.WriterOptions-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createWriter</h4> |
| <pre>public static <a href="../../../org/apache/orc/Writer.html" title="interface in org.apache.orc">Writer</a> createWriter(<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> path, |
| <a href="../../../org/apache/orc/OrcFile.WriterOptions.html" title="class in org.apache.orc">OrcFile.WriterOptions</a> 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> |
| <div class="block">Create an ORC file writer. This is the public interface for creating |
| writers going forward and new options will only be added to this method.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>path</code> - filename to write to</dd> |
| <dd><code>opts</code> - the options</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new ORC file writer</dd> |
| <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> |
| <a name="mergeFiles-org.apache.hadoop.fs.Path-org.apache.orc.OrcFile.WriterOptions-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>mergeFiles</h4> |
| <pre>public static <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<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>> mergeFiles(<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> outputPath, |
| <a href="../../../org/apache/orc/OrcFile.WriterOptions.html" title="class in org.apache.orc">OrcFile.WriterOptions</a> options, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<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>> inputFiles) |
| 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> |
| <div class="block">Merges multiple ORC files that all have the same schema to produce |
| a single ORC file. |
| The merge will reject files that aren't compatible with the merged file |
| so the output list may be shorter than the input list. |
| The stripes are copied as serialized byte buffers. |
| The user metadata are merged and files that disagree on the value |
| associated with a key will be rejected.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>outputPath</code> - the output file</dd> |
| <dd><code>options</code> - the options for writing with although the options related |
| to the input files' encodings are overridden</dd> |
| <dd><code>inputFiles</code> - the list of files to merge</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the list of files that were successfully merged</dd> |
| <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/OrcFile.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/OrcConf.html" title="enum in org.apache.orc"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../org/apache/orc/OrcFile.BloomFilterVersion.html" title="enum in org.apache.orc"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?org/apache/orc/OrcFile.html" target="_top">Frames</a></li> |
| <li><a href="OrcFile.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../allclasses-noframe.html">All 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: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2013–2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
