(orc) branch branch-2.0 updated: ORC-1612: Document available encodings at `orc.compress`

[dongjoon]

This is an automated email from the ASF dual-hosted git repository.

dongjoon pushed a commit to branch branch-2.0
in repository https://gitbox.apache.org/repos/asf/orc.git


The following commit(s) were added to refs/heads/branch-2.0 by this push:
     new 0409fd6d4 ORC-1612: Document available encodings at `orc.compress`
0409fd6d4 is described below

commit 0409fd6d4c819ec64c2cfd824a9facddd4e5b658
Author: sychen <syc...@ctrip.com>
AuthorDate: Wed Feb 7 18:57:19 2024 -0800

    ORC-1612: Document available encodings at `orc.compress`
    
    ### 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 <syc...@ctrip.com>
    Signed-off-by: Dongjoon Hyun <dongj...@apache.org>
    (cherry picked from commit 6f7d14e8be80a0b5f05b9c0cc4f2716bbf71972a)
    Signed-off-by: Dongjoon Hyun <dongj...@apache.org>
---
 java/core/src/java/org/apache/orc/OrcConf.java | 3 ++-
 site/_docs/core-java-config.md                 | 2 +-
 2 files changed, 3 insertions(+), 2 deletions(-)

diff --git a/java/core/src/java/org/apache/orc/OrcConf.java 
b/java/core/src/java/org/apache/orc/OrcConf.java
index 17f5d4f3c..9bc2b4492 100644
--- a/java/core/src/java/org/apache/orc/OrcConf.java
+++ b/java/core/src/java/org/apache/orc/OrcConf.java
@@ -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" +
diff --git a/site/_docs/core-java-config.md b/site/_docs/core-java-config.md
index 6db1cbd0a..067852a47 100644
--- a/site/_docs/core-java-config.md
+++ b/site/_docs/core-java-config.md
@@ -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>