This is an automated email from the ASF dual-hosted git repository.
lzljs3620320 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-paimon.git
The following commit(s) were added to refs/heads/master by this push:
new 8eff9fbe3 [doc] Add infinite annotations for the configuration options
whose default value is MAX_VALUE (#2887)
8eff9fbe3 is described below
commit 8eff9fbe3625c1d7ba00c11d5d8966630fa63429
Author: Lijie Wang <[email protected]>
AuthorDate: Thu Feb 22 18:05:37 2024 +0800
[doc] Add infinite annotations for the configuration options whose default
value is MAX_VALUE (#2887)
---
docs/layouts/shortcodes/generated/core_configuration.html | 4 ++--
paimon-common/src/main/java/org/apache/paimon/CoreOptions.java | 3 +++
2 files changed, 5 insertions(+), 2 deletions(-)
diff --git a/docs/layouts/shortcodes/generated/core_configuration.html
b/docs/layouts/shortcodes/generated/core_configuration.html
index 8581a7d13..2e25fe96b 100644
--- a/docs/layouts/shortcodes/generated/core_configuration.html
+++ b/docs/layouts/shortcodes/generated/core_configuration.html
@@ -263,7 +263,7 @@ Mainly to resolve data skew on primary keys. We recommend
starting with 64 mb wh
</tr>
<tr>
<td><h5>lookup.cache-max-disk-size</h5></td>
- <td style="word-wrap: break-word;">9223372036854775807 bytes</td>
+ <td style="word-wrap: break-word;">infinite</td>
<td>MemorySize</td>
<td>Max disk size for lookup cache, you can use this option to
limit the use of local disks.</td>
</tr>
@@ -565,7 +565,7 @@ This config option does not affect the default filesystem
metastore.</td>
</tr>
<tr>
<td><h5>snapshot.num-retained.max</h5></td>
- <td style="word-wrap: break-word;">2147483647</td>
+ <td style="word-wrap: break-word;">infinite</td>
<td>Integer</td>
<td>The maximum number of completed snapshots to retain. Should be
greater than or equal to the minimum number.</td>
</tr>
diff --git a/paimon-common/src/main/java/org/apache/paimon/CoreOptions.java
b/paimon-common/src/main/java/org/apache/paimon/CoreOptions.java
index 5fa99fb82..6430c919e 100644
--- a/paimon-common/src/main/java/org/apache/paimon/CoreOptions.java
+++ b/paimon-common/src/main/java/org/apache/paimon/CoreOptions.java
@@ -18,6 +18,7 @@
package org.apache.paimon;
+import org.apache.paimon.annotation.Documentation;
import org.apache.paimon.annotation.Documentation.ExcludeFromDocumentation;
import org.apache.paimon.annotation.Documentation.Immutable;
import org.apache.paimon.annotation.VisibleForTesting;
@@ -190,6 +191,7 @@ public class CoreOptions implements Serializable {
.withDescription(
"The minimum number of completed snapshots to
retain. Should be greater than or equal to 1.");
+ @Documentation.OverrideDefault("infinite")
public static final ConfigOption<Integer> SNAPSHOT_NUM_RETAINED_MAX =
key("snapshot.num-retained.max")
.intType()
@@ -723,6 +725,7 @@ public class CoreOptions implements Serializable {
+ " if there is a need for access, it will
be re-read from the DFS to build"
+ " an index on the local disk.");
+ @Documentation.OverrideDefault("infinite")
public static final ConfigOption<MemorySize> LOOKUP_CACHE_MAX_DISK_SIZE =
key("lookup.cache-max-disk-size")
.memoryType()
