From 37afa23a6f03a40fbef9fbc83d2971e1ae9b5c1c Mon Sep 17 00:00:00 2001 From: Y Ethan Guo Date: Sat, 17 Sep 2022 00:53:30 -0700 Subject: [PATCH] [HUDI-4870] Improve compaction config description --- .../org/apache/hudi/config/HoodieCompactionConfig.java | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/hudi-client/hudi-client-common/src/main/java/org/apache/hudi/config/HoodieCompactionConfig.java b/hudi-client/hudi-client-common/src/main/java/org/apache/hudi/config/HoodieCompactionConfig.java index d1d0e6726173b..8e154fec17a65 100644 --- a/hudi-client/hudi-client-common/src/main/java/org/apache/hudi/config/HoodieCompactionConfig.java +++ b/hudi-client/hudi-client-common/src/main/java/org/apache/hudi/config/HoodieCompactionConfig.java @@ -64,12 +64,16 @@ public class HoodieCompactionConfig extends HoodieConfig { public static final ConfigProperty INLINE_COMPACT_NUM_DELTA_COMMITS = ConfigProperty .key("hoodie.compact.inline.max.delta.commits") .defaultValue("5") - .withDocumentation("Number of delta commits after the last compaction, before scheduling of a new compaction is attempted."); + .withDocumentation("Number of delta commits after the last compaction, before scheduling of a new compaction is attempted. " + + "This config takes effect only for the compaction triggering strategy based on the number of commits, " + + "i.e., NUM_COMMITS, NUM_COMMITS_AFTER_LAST_REQUEST, NUM_AND_TIME, and NUM_OR_TIME."); public static final ConfigProperty INLINE_COMPACT_TIME_DELTA_SECONDS = ConfigProperty .key("hoodie.compact.inline.max.delta.seconds") .defaultValue(String.valueOf(60 * 60)) - .withDocumentation("Number of elapsed seconds after the last compaction, before scheduling a new one."); + .withDocumentation("Number of elapsed seconds after the last compaction, before scheduling a new one. " + + "This config takes effect only for the compaction triggering strategy based on the elapsed time, " + + "i.e., TIME_ELAPSED, NUM_AND_TIME, and NUM_OR_TIME."); public static final ConfigProperty INLINE_COMPACT_TRIGGER_STRATEGY = ConfigProperty .key("hoodie.compact.inline.trigger.strategy")