You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@orc.apache.org by do...@apache.org on 2026/07/16 21:18:11 UTC
(orc) branch asf-site updated: ORC-2207: Use `javadoc.io` links in `site` docs
This is an automated email from the ASF dual-hosted git repository.
dongjoon-hyun pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/orc.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 0a8677a31 ORC-2207: Use `javadoc.io` links in `site` docs
0a8677a31 is described below
commit 0a8677a310b91c7e8cd1a58379b3aff3c942b52f
Author: Dongjoon Hyun <do...@apache.org>
AuthorDate: Thu Jul 16 14:17:57 2026 -0700
ORC-2207: Use `javadoc.io` links in `site` docs
---
docs/core-java.html | 10 +++++-----
docs/mapred.html | 18 +++++++++---------
docs/mapreduce.html | 18 +++++++++---------
3 files changed, 23 insertions(+), 23 deletions(-)
diff --git a/docs/core-java.html b/docs/core-java.html
index b2eb851c1..cfaa1eedb 100644
--- a/docs/core-java.html
+++ b/docs/core-java.html
@@ -1356,9 +1356,9 @@ keys and values.</p>
<h3 id="simple-example">Simple Example</h3>
<p>To write an ORC file, you need to define the schema and use the
-<a href="/api/orc-core/index.html?org/apache/orc/OrcFile.html">OrcFile</a>
+<a href="https://javadoc.io/doc/org.apache.orc/orc-core/latest/org/apache/orc/OrcFile.html">OrcFile</a>
class to create a
-<a href="/api/orc-core/index.html?org/apache/orc/Writer.html">Writer</a>
+<a href="https://javadoc.io/doc/org.apache.orc/orc-core/latest/org/apache/orc/Writer.html">Writer</a>
with the desired filename. This example sets the required schema
parameter, but there are many other options to control the ORC writer.</p>
@@ -1459,9 +1459,9 @@ ranging from “<row>.0” to “<row>.4”.</p>
<h2 id="reading-orc-files">Reading ORC Files</h2>
<p>To read ORC files, use the
-<a href="/api/orc-core/index.html?org/apache/orc/OrcFile.html">OrcFile</a>
+<a href="https://javadoc.io/doc/org.apache.orc/orc-core/latest/org/apache/orc/OrcFile.html">OrcFile</a>
class to create a
-<a href="/api/orc-core/index.html?org/apache/orc/Reader.html">Reader</a>
+<a href="https://javadoc.io/doc/org.apache.orc/orc-core/latest/org/apache/orc/Reader.html">Reader</a>
that contains the metadata about the file. There are a few options to
the ORC reader, but far fewer than the writer and none of them are
required. The reader has methods for getting the number of rows,
@@ -1472,7 +1472,7 @@ schema, compression, etc. from the file.</p>
</code></pre></div></div>
<p>To get the data, create a
-<a href="/api/orc-core/index.html?org/apache/orc/RecordReader.html">RecordReader</a>
+<a href="https://javadoc.io/doc/org.apache.orc/orc-core/latest/org/apache/orc/RecordReader.html">RecordReader</a>
object. By default, the RecordReader reads all rows and all columns,
but there are options to control the data that is read.</p>
diff --git a/docs/mapred.html b/docs/mapred.html
index f8b45f282..b138ef41c 100644
--- a/docs/mapred.html
+++ b/docs/mapred.html
@@ -1123,7 +1123,7 @@ page</a>.</p>
<p>Set the minimal properties in your JobConf:</p>
<ul>
- <li><strong>mapreduce.job.inputformat.class</strong> = <a href="/api/orc-mapreduce/index.html?org/apache/orc/mapred/OrcInputFormat.html">org.apache.orc.mapred.OrcInputFormat</a></li>
+ <li><strong>mapreduce.job.inputformat.class</strong> = <a href="https://javadoc.io/doc/org.apache.orc/orc-mapreduce/latest/org/apache/orc/mapred/OrcInputFormat.html">org.apache.orc.mapred.OrcInputFormat</a></li>
<li><strong>mapreduce.input.fileinputformat.inputdir</strong> = your input directory</li>
</ul>
@@ -1146,7 +1146,7 @@ the key and a value based on the table below expanded recursively.</p>
<tbody>
<tr>
<td>array</td>
- <td><a href="/api/orc-mapreduce/index.html?org/apache/orc/mapred/OrcStruct.html">org.apache.orc.mapred.OrcList</a></td>
+ <td><a href="https://javadoc.io/doc/org.apache.orc/orc-mapreduce/latest/org/apache/orc/mapred/OrcStruct.html">org.apache.orc.mapred.OrcList</a></td>
</tr>
<tr>
<td>binary</td>
@@ -1186,7 +1186,7 @@ the key and a value based on the table below expanded recursively.</p>
</tr>
<tr>
<td>map</td>
- <td><a href="/api/orc-mapreduce/index.html?org/apache/orc/mapred/OrcMap.html">org.apache.orc.mapred.OrcMap</a></td>
+ <td><a href="https://javadoc.io/doc/org.apache.orc/orc-mapreduce/latest/org/apache/orc/mapred/OrcMap.html">org.apache.orc.mapred.OrcMap</a></td>
</tr>
<tr>
<td>smallint</td>
@@ -1198,11 +1198,11 @@ the key and a value based on the table below expanded recursively.</p>
</tr>
<tr>
<td>struct</td>
- <td><a href="/api/orc-mapreduce/index.html?org/apache/orc/mapred/OrcStruct.html">org.apache.orc.mapred.OrcStruct</a></td>
+ <td><a href="https://javadoc.io/doc/org.apache.orc/orc-mapreduce/latest/org/apache/orc/mapred/OrcStruct.html">org.apache.orc.mapred.OrcStruct</a></td>
</tr>
<tr>
<td>timestamp</td>
- <td><a href="/api/orc-mapreduce/index.html?org/apache/orc/mapred/OrcTimestamp.html">org.apache.orc.mapred.OrcTimestamp</a></td>
+ <td><a href="https://javadoc.io/doc/org.apache.orc/orc-mapreduce/latest/org/apache/orc/mapred/OrcTimestamp.html">org.apache.orc.mapred.OrcTimestamp</a></td>
</tr>
<tr>
<td>tinyint</td>
@@ -1210,7 +1210,7 @@ the key and a value based on the table below expanded recursively.</p>
</tr>
<tr>
<td>uniontype</td>
- <td><a href="/api/orc-mapreduce/index.html?org/apache/orc/mapred/OrcUnion.html">org.apache.orc.mapred.OrcUnion</a></td>
+ <td><a href="https://javadoc.io/doc/org.apache.orc/orc-mapreduce/latest/org/apache/orc/mapred/OrcUnion.html">org.apache.orc.mapred.OrcUnion</a></td>
</tr>
<tr>
<td>varchar</td>
@@ -1246,7 +1246,7 @@ mapper code would look like:</p>
<p>To write ORC files from your MapReduce job, you’ll need to set</p>
<ul>
- <li><strong>mapreduce.job.outputformat.class</strong> = <a href="/api/orc-mapreduce/index.html?org/apache/orc/mapred/OrcOutputFormat.html">org.apache.orc.mapred.OrcOutputFormat</a></li>
+ <li><strong>mapreduce.job.outputformat.class</strong> = <a href="https://javadoc.io/doc/org.apache.orc/orc-mapreduce/latest/org/apache/orc/mapred/OrcOutputFormat.html">org.apache.orc.mapred.OrcOutputFormat</a></li>
<li><strong>mapreduce.output.fileoutputformat.outputdir</strong> = your output directory</li>
<li><strong>orc.mapred.output.schema</strong> = the schema to write to the ORC file</li>
</ul>
@@ -1296,9 +1296,9 @@ MapReduce shuffle. The complex ORC types, since they are generic
types, need to have their full type information provided to create the
object. To enable MapReduce to properly instantiate the OrcStruct and
other ORC types, we need to wrap it in either an
-<a href="/api/orc-mapreduce/index.html?org/apache/orc/mapred/OrcKey.html">OrcKey</a>
+<a href="https://javadoc.io/doc/org.apache.orc/orc-mapreduce/latest/org/apache/orc/mapred/OrcKey.html">OrcKey</a>
for the shuffle key or
-<a href="/api/orc-mapreduce/index.html?org/apache/orc/mapred/OrcValue.html">OrcValue</a>
+<a href="https://javadoc.io/doc/org.apache.orc/orc-mapreduce/latest/org/apache/orc/mapred/OrcValue.html">OrcValue</a>
for the shuffle value.</p>
<p>To send two OrcStructs through the shuffle, define the following properties
diff --git a/docs/mapreduce.html b/docs/mapreduce.html
index 93842caa7..9e77ccb8d 100644
--- a/docs/mapreduce.html
+++ b/docs/mapreduce.html
@@ -1123,7 +1123,7 @@ page</a>.</p>
<p>Set the minimal properties in your JobConf:</p>
<ul>
- <li><strong>mapreduce.job.inputformat.class</strong> = <a href="/api/orc-mapreduce/index.html?org/apache/orc/mapreduce/OrcInputFormat.html">org.apache.orc.mapreduce.OrcInputFormat</a></li>
+ <li><strong>mapreduce.job.inputformat.class</strong> = <a href="https://javadoc.io/doc/org.apache.orc/orc-mapreduce/latest/org/apache/orc/mapreduce/OrcInputFormat.html">org.apache.orc.mapreduce.OrcInputFormat</a></li>
<li><strong>mapreduce.input.fileinputformat.inputdir</strong> = your input directory</li>
</ul>
@@ -1146,7 +1146,7 @@ the key and a value based on the table below expanded recursively.</p>
<tbody>
<tr>
<td>array</td>
- <td><a href="/api/orc-mapreduce/index.html?org/apache/orc/mapred/OrcStruct.html">org.apache.orc.mapred.OrcList</a></td>
+ <td><a href="https://javadoc.io/doc/org.apache.orc/orc-mapreduce/latest/org/apache/orc/mapred/OrcStruct.html">org.apache.orc.mapred.OrcList</a></td>
</tr>
<tr>
<td>binary</td>
@@ -1186,7 +1186,7 @@ the key and a value based on the table below expanded recursively.</p>
</tr>
<tr>
<td>map</td>
- <td><a href="/api/orc-mapreduce/index.html?org/apache/orc/mapred/OrcMap.html">org.apache.orc.mapred.OrcMap</a></td>
+ <td><a href="https://javadoc.io/doc/org.apache.orc/orc-mapreduce/latest/org/apache/orc/mapred/OrcMap.html">org.apache.orc.mapred.OrcMap</a></td>
</tr>
<tr>
<td>smallint</td>
@@ -1198,11 +1198,11 @@ the key and a value based on the table below expanded recursively.</p>
</tr>
<tr>
<td>struct</td>
- <td><a href="/api/orc-mapreduce/index.html?org/apache/orc/mapred/OrcStruct.html">org.apache.orc.mapred.OrcStruct</a></td>
+ <td><a href="https://javadoc.io/doc/org.apache.orc/orc-mapreduce/latest/org/apache/orc/mapred/OrcStruct.html">org.apache.orc.mapred.OrcStruct</a></td>
</tr>
<tr>
<td>timestamp</td>
- <td><a href="/api/orc-mapreduce/index.html?org/apache/orc/mapred/OrcTimestamp.html">org.apache.orc.mapred.OrcTimestamp</a></td>
+ <td><a href="https://javadoc.io/doc/org.apache.orc/orc-mapreduce/latest/org/apache/orc/mapred/OrcTimestamp.html">org.apache.orc.mapred.OrcTimestamp</a></td>
</tr>
<tr>
<td>tinyint</td>
@@ -1210,7 +1210,7 @@ the key and a value based on the table below expanded recursively.</p>
</tr>
<tr>
<td>uniontype</td>
- <td><a href="/api/orc-mapreduce/index.html?org/apache/orc/mapred/OrcUnion.html">org.apache.orc.mapred.OrcUnion</a></td>
+ <td><a href="https://javadoc.io/doc/org.apache.orc/orc-mapreduce/latest/org/apache/orc/mapred/OrcUnion.html">org.apache.orc.mapred.OrcUnion</a></td>
</tr>
<tr>
<td>varchar</td>
@@ -1242,7 +1242,7 @@ mapper code would look like:</p>
<p>To write ORC files from your MapReduce job, you’ll need to set</p>
<ul>
- <li><strong>mapreduce.job.outputformat.class</strong> = <a href="/api/orc-mapreduce/index.html?org/apache/orc/mapreduce/OrcOutputFormat.html">org.apache.orc.mapreduce.OrcOutputFormat</a></li>
+ <li><strong>mapreduce.job.outputformat.class</strong> = <a href="https://javadoc.io/doc/org.apache.orc/orc-mapreduce/latest/org/apache/orc/mapreduce/OrcOutputFormat.html">org.apache.orc.mapreduce.OrcOutputFormat</a></li>
<li><strong>mapreduce.output.fileoutputformat.outputdir</strong> = your output directory</li>
<li><strong>orc.mapred.output.schema</strong> = the schema to write to the ORC file</li>
</ul>
@@ -1288,9 +1288,9 @@ MapReduce shuffle. The complex ORC types, since they are generic
types, need to have their full type information provided to create the
object. To enable MapReduce to properly instantiate the OrcStruct and
other ORC types, we need to wrap it in either an
-<a href="/api/orc-mapreduce/index.html?org/apache/orc/mapred/OrcKey.html">OrcKey</a>
+<a href="https://javadoc.io/doc/org.apache.orc/orc-mapreduce/latest/org/apache/orc/mapred/OrcKey.html">OrcKey</a>
for the shuffle key or
-<a href="/api/orc-mapreduce/index.html?org/apache/orc/mapred/OrcValue.html">OrcValue</a>
+<a href="https://javadoc.io/doc/org.apache.orc/orc-mapreduce/latest/org/apache/orc/mapred/OrcValue.html">OrcValue</a>
for the shuffle value.</p>
<p>To send two OrcStructs through the shuffle, define the following properties