Skip to content

Commit

Permalink
ORC-1612: Document available encodings at orc.compress
Browse files Browse the repository at this point in the history
### What changes were proposed in this pull request?
Added documentation about optional compression encoding enum values ​​for `orc.compress`.

### Why are the changes needed?
Currently ORC has a wealth of optional encoders, but they are not documented in the documentation.

### How was this patch tested?
GA

### Was this patch authored or co-authored using generative AI tooling?
No

Closes #1788 from cxzl25/ORC-1612.

Authored-by: sychen <sychen@ctrip.com>
Signed-off-by: Dongjoon Hyun <dongjoon@apache.org>
(cherry picked from commit 6f7d14e)
Signed-off-by: Dongjoon Hyun <dongjoon@apache.org>
  • Loading branch information
cxzl25 authored and dongjoon-hyun committed Feb 8, 2024
1 parent fb40a39 commit 0409fd6
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 2 deletions.
3 changes: 2 additions & 1 deletion java/core/src/java/org/apache/orc/OrcConf.java
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,8 @@ public enum OrcConf {
true,
"Define whether stripes should be padded to the HDFS block boundaries."),
COMPRESS("orc.compress", "hive.exec.orc.default.compress", "ZSTD",
"Define the default compression codec for ORC file"),
"Define the default compression codec for ORC file. " +
"It can be NONE, ZLIB, SNAPPY, LZO, LZ4, ZSTD, BROTLI."),
WRITE_FORMAT("orc.write.format", "hive.exec.orc.write.format", "0.12",
"Define the version of the file to write. Possible values are 0.11 and\n"+
" 0.12. If this parameter is not defined, ORC will use the run\n" +
Expand Down
2 changes: 1 addition & 1 deletion site/_docs/core-java-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ permalink: /docs/core-java-config.html
<td><code>orc.compress</code></td>
<td>ZSTD</td>
<td>
Define the default compression codec for ORC file
Define the default compression codec for ORC file. It can be NONE, ZLIB, SNAPPY, LZO, LZ4, ZSTD, BROTLI.
</td>
</tr>
<tr>
Expand Down

0 comments on commit 0409fd6

Please sign in to comment.