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/paimon.git
The following commit(s) were added to refs/heads/master by this push:
new 59e0ae11b [doc] Fix duplicate possible values in the configuration
doc. (#3821)
59e0ae11b is described below
commit 59e0ae11b4955a113c2b14eb6d26cf9789d0d1ea
Author: HunterXHunter <[email protected]>
AuthorDate: Sun Jul 28 11:18:17 2024 +0800
[doc] Fix duplicate possible values in the configuration doc. (#3821)
---
.../shortcodes/generated/core_configuration.html | 4 +--
.../main/java/org/apache/paimon/CoreOptions.java | 40 ++++------------------
2 files changed, 8 insertions(+), 36 deletions(-)
diff --git a/docs/layouts/shortcodes/generated/core_configuration.html
b/docs/layouts/shortcodes/generated/core_configuration.html
index 0ecdbd634..d6eb50235 100644
--- a/docs/layouts/shortcodes/generated/core_configuration.html
+++ b/docs/layouts/shortcodes/generated/core_configuration.html
@@ -519,7 +519,7 @@ This config option does not affect the default filesystem
metastore.</td>
<td><h5>partition.expiration-strategy</h5></td>
<td style="word-wrap: break-word;">values-time</td>
<td><p>Enum</p></td>
- <td>Specifies the expiration strategy for partition expiration.<br
/>Possible values:<ul><li>values-time: A partition expiration policy that
compares the time extracted from the partition value with the current
time.</li></ul><ul><li>update-time: A partition expiration policy that compares
the last update time of the partition with the current time.</li></ul><br /><br
/>Possible values:<ul><li>"values-time": The strategy compares the time
extracted from the partition value wi [...]
+ <td>The strategy determines how to extract the partition time and
compare it with the current time.<br /><br />Possible
values:<ul><li>"values-time": This strategy compares the time extracted from
the partition value with the current time.</li><li>"update-time": This strategy
compares the last update time of the partition with the current
time.</li></ul></td>
</tr>
<tr>
<td><h5>partition.expiration-time</h5></td>
@@ -748,7 +748,7 @@ If the data size allocated for the sorting task is
uneven,which may lead to perf
<td><h5>streaming-read-mode</h5></td>
<td style="word-wrap: break-word;">(none)</td>
<td><p>Enum</p></td>
- <td>The mode of streaming read that specifies to read the data of
table file or log<br /><br />Possible values:<br /><ul><li>file: Reads from the
data of table file store.</li></ul><ul><li>log: Read from the data of table log
store.</li></ul><br /><br />Possible values:<ul><li>"log": Reads from the log
store.</li><li>"file": Reads from the file store.</li></ul></td>
+ <td>The mode of streaming read that specifies to read the data of
table file or log.<br /><br />Possible values:<ul><li>"log": Read from the data
of table log store.</li><li>"file": Read from the data of table file
store.</li></ul></td>
</tr>
<tr>
<td><h5>streaming-read-overwrite</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
index ade36f295..685634e26 100644
--- a/paimon-common/src/main/java/org/apache/paimon/CoreOptions.java
+++ b/paimon-common/src/main/java/org/apache/paimon/CoreOptions.java
@@ -707,20 +707,7 @@ public class CoreOptions implements Serializable {
.enumType(PartitionExpireStrategy.class)
.defaultValue(PartitionExpireStrategy.VALUES_TIME)
.withDescription(
- Description.builder()
- .text(
- "Specifies the expiration strategy
for partition expiration.")
- .linebreak()
- .text("Possible values:")
- .list(
- text(
-
PartitionExpireStrategy.VALUES_TIME.value
- + ": A partition
expiration policy that compares the time extracted from the partition value
with the current time."))
- .list(
- text(
-
PartitionExpireStrategy.UPDATE_TIME.value
- + ": A partition
expiration policy that compares the last update time of the partition with the
current time."))
- .build());
+ "The strategy determines how to extract the
partition time and compare it with the current time.");
public static final ConfigOption<Duration> PARTITION_EXPIRATION_TIME =
key("partition.expiration-time")
@@ -898,22 +885,7 @@ public class CoreOptions implements Serializable {
.enumType(StreamingReadMode.class)
.noDefaultValue()
.withDescription(
- Description.builder()
- .text(
- "The mode of streaming read that
specifies to read the data of table file or log")
- .linebreak()
- .linebreak()
- .text("Possible values:")
- .linebreak()
- .list(
- text(
-
StreamingReadMode.FILE.getValue()
- + ": Reads from
the data of table file store."))
- .list(
- text(
-
StreamingReadMode.LOG.getValue()
- + ": Read from the
data of table log store."))
- .build());
+ "The mode of streaming read that specifies to read
the data of table file or log.");
public static final ConfigOption<Duration> CONSUMER_EXPIRATION_TIME =
key("consumer.expiration-time")
@@ -2249,8 +2221,8 @@ public class CoreOptions implements Serializable {
/** Specifies the type for streaming read. */
public enum StreamingReadMode implements DescribedEnum {
- LOG("log", "Reads from the log store."),
- FILE("file", "Reads from the file store.");
+ LOG("log", "Read from the data of table log store."),
+ FILE("file", "Read from the data of table file store.");
private final String value;
private final String description;
@@ -2601,11 +2573,11 @@ public class CoreOptions implements Serializable {
public enum PartitionExpireStrategy implements DescribedEnum {
VALUES_TIME(
"values-time",
- "The strategy compares the time extracted from the partition
value with the current time."),
+ "This strategy compares the time extracted from the partition
value with the current time."),
UPDATE_TIME(
"update-time",
- "The strategy compares the last update time of the partition
with the current time.");
+ "This strategy compares the last update time of the partition
with the current time.");
private final String value;
