From 59e0ae11b4955a113c2b14eb6d26cf9789d0d1ea Mon Sep 17 00:00:00 2001 From: HunterXHunter Date: Sun, 28 Jul 2024 11:18:17 +0800 Subject: [PATCH] [doc] Fix duplicate possible values in the configuration doc. (#3821) --- .../generated/core_configuration.html | 4 +- .../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 0ecdbd634180..d6eb502353f5 100644 --- a/docs/layouts/shortcodes/generated/core_configuration.html +++ b/docs/layouts/shortcodes/generated/core_configuration.html @@ -519,7 +519,7 @@
partition.expiration-strategy
values-time

Enum

- Specifies the expiration strategy for partition expiration.
Possible values:

Possible values: + The strategy determines how to extract the partition time and compare it with the current time.

Possible values:
partition.expiration-time
@@ -748,7 +748,7 @@
streaming-read-mode
(none)

Enum

- The mode of streaming read that specifies to read the data of table file or log

Possible values:


Possible values: + The mode of streaming read that specifies to read the data of table file or log.

Possible values:
streaming-read-overwrite
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 ade36f2959c8..685634e2650a 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 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 CONSUMER_EXPIRATION_TIME = key("consumer.expiration-time") @@ -2249,8 +2221,8 @@ public InlineElement getDescription() { /** 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 InlineElement getDescription() { 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;