Skip to content

Commit 37afa23

Browse files
committed
[HUDI-4870] Improve compaction config description
1 parent 21cbfce commit 37afa23

1 file changed

Lines changed: 6 additions & 2 deletions

File tree

hudi-client/hudi-client-common/src/main/java/org/apache/hudi/config/HoodieCompactionConfig.java

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,12 +64,16 @@ public class HoodieCompactionConfig extends HoodieConfig {
6464
public static final ConfigProperty<String> INLINE_COMPACT_NUM_DELTA_COMMITS = ConfigProperty
6565
.key("hoodie.compact.inline.max.delta.commits")
6666
.defaultValue("5")
67-
.withDocumentation("Number of delta commits after the last compaction, before scheduling of a new compaction is attempted.");
67+
.withDocumentation("Number of delta commits after the last compaction, before scheduling of a new compaction is attempted. "
68+
+ "This config takes effect only for the compaction triggering strategy based on the number of commits, "
69+
+ "i.e., NUM_COMMITS, NUM_COMMITS_AFTER_LAST_REQUEST, NUM_AND_TIME, and NUM_OR_TIME.");
6870

6971
public static final ConfigProperty<String> INLINE_COMPACT_TIME_DELTA_SECONDS = ConfigProperty
7072
.key("hoodie.compact.inline.max.delta.seconds")
7173
.defaultValue(String.valueOf(60 * 60))
72-
.withDocumentation("Number of elapsed seconds after the last compaction, before scheduling a new one.");
74+
.withDocumentation("Number of elapsed seconds after the last compaction, before scheduling a new one. "
75+
+ "This config takes effect only for the compaction triggering strategy based on the elapsed time, "
76+
+ "i.e., TIME_ELAPSED, NUM_AND_TIME, and NUM_OR_TIME.");
7377

7478
public static final ConfigProperty<String> INLINE_COMPACT_TRIGGER_STRATEGY = ConfigProperty
7579
.key("hoodie.compact.inline.trigger.strategy")

0 commit comments

Comments
 (0)