[core] Explain tag.num-retained-max (#3555)

apache · Jun 20, 2024 · 9e98cda · 9e98cda
1 parent 6ef57bc
commit 9e98cda
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 4 deletions.
diff --git a/docs/layouts/shortcodes/generated/core_configuration.html b/docs/layouts/shortcodes/generated/core_configuration.html
@@ -754,13 +754,13 @@
             <td><h5>tag.default-time-retained</h5></td>
             <td style="word-wrap: break-word;">(none)</td>
             <td>Duration</td>
-            <td>The default maximum time retained for newly created tags.</td>
+            <td>The default maximum time retained for newly created tags. It affects both auto-created tags and manually created (by procedure) tags.</td>
         </tr>
         <tr>
             <td><h5>tag.num-retained-max</h5></td>
             <td style="word-wrap: break-word;">(none)</td>
             <td>Integer</td>
-            <td>The maximum number of tags to retain.</td>
+            <td>The maximum number of tags to retain. It only affects auto-created tags.</td>
         </tr>
         <tr>
             <td><h5>tag.period-formatter</h5></td>

diff --git a/paimon-common/src/main/java/org/apache/paimon/CoreOptions.java b/paimon-common/src/main/java/org/apache/paimon/CoreOptions.java
@@ -1057,13 +1057,16 @@ public class CoreOptions implements Serializable {
             key("tag.num-retained-max")
                     .intType()
                     .noDefaultValue()
-                    .withDescription("The maximum number of tags to retain.");
+                    .withDescription(
+                            "The maximum number of tags to retain. It only affects auto-created tags.");
 
     public static final ConfigOption<Duration> TAG_DEFAULT_TIME_RETAINED =
             key("tag.default-time-retained")
                     .durationType()
                     .noDefaultValue()
-                    .withDescription("The default maximum time retained for newly created tags.");
+                    .withDescription(
+                            "The default maximum time retained for newly created tags. "
+                                    + "It affects both auto-created tags and manually created (by procedure) tags.");
 
     public static final ConfigOption<Duration> SNAPSHOT_WATERMARK_IDLE_TIMEOUT =
             key("snapshot.watermark-idle-timeout")