From 0409fd6d4c819ec64c2cfd824a9facddd4e5b658 Mon Sep 17 00:00:00 2001 From: sychen Date: Wed, 7 Feb 2024 18:57:19 -0800 Subject: [PATCH] ORC-1612: Document available encodings at `orc.compress` MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ### 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 Signed-off-by: Dongjoon Hyun (cherry picked from commit 6f7d14e8be80a0b5f05b9c0cc4f2716bbf71972a) Signed-off-by: Dongjoon Hyun --- 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 17f5d4f3c3..9bc2b4492e 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 6db1cbd0a2..067852a472 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 orc.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.