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/flink-table-store.git
The following commit(s) were added to refs/heads/master by this push:
new 61dd4e10 [hotfix] Minor fix configuration documentation page
61dd4e10 is described below
commit 61dd4e10d727471de12a971d1ac24e1a9f132e43
Author: JingsongLi <[email protected]>
AuthorDate: Tue Jul 5 16:57:48 2022 +0800
[hotfix] Minor fix configuration documentation page
---
docs/content/docs/development/configuration.md | 8 ++--
.../generated/catalog_configuration.html | 2 +-
.../shortcodes/generated/core_configuration.html | 10 ++---
.../flink/table/store/utils/OptionsUtils.java | 32 ---------------
.../apache/flink/table/store/CatalogOptions.java | 4 +-
.../org/apache/flink/table/store/CoreOptions.java | 46 +++-------------------
6 files changed, 18 insertions(+), 84 deletions(-)
diff --git a/docs/content/docs/development/configuration.md
b/docs/content/docs/development/configuration.md
index fc9caf49..aa0871d3 100644
--- a/docs/content/docs/development/configuration.md
+++ b/docs/content/docs/development/configuration.md
@@ -26,25 +26,25 @@ under the License.
# Configuration
-**`CoreOptions`**
+### CoreOptions
Core options for table store.
{{< generated/core_configuration >}}
-**`CatalogOptions`**
+### CatalogOptions
Options for table store catalog.
{{< generated/catalog_configuration >}}
-**`FlinkConnectorOptions`**
+### FlinkConnectorOptions
Flink connector options for table store.
{{< generated/flink_connector_configuration >}}
-**`KafkaLogOptions`**
+### KafkaLogOptions
Kafka log options provided after configuring `log.system` for kafka.
diff --git a/docs/layouts/shortcodes/generated/catalog_configuration.html
b/docs/layouts/shortcodes/generated/catalog_configuration.html
index f8991bd7..ba90de08 100644
--- a/docs/layouts/shortcodes/generated/catalog_configuration.html
+++ b/docs/layouts/shortcodes/generated/catalog_configuration.html
@@ -12,7 +12,7 @@
<td><h5>metastore</h5></td>
<td style="word-wrap: break-word;">"filesystem"</td>
<td>String</td>
- <td></td>
+ <td>Metastore of table store catalog, supports filesystem and
hive.</td>
</tr>
<tr>
<td><h5>uri</h5></td>
diff --git a/docs/layouts/shortcodes/generated/core_configuration.html
b/docs/layouts/shortcodes/generated/core_configuration.html
index 84a64f3b..304e7585 100644
--- a/docs/layouts/shortcodes/generated/core_configuration.html
+++ b/docs/layouts/shortcodes/generated/core_configuration.html
@@ -60,13 +60,13 @@
<td><h5>log.changelog-mode</h5></td>
<td style="word-wrap: break-word;">auto</td>
<td><p>Enum</p></td>
- <td>Specify the log changelog mode for table.<br /><ul><li>"auto":
Upsert for table with primary key, all for table without primary
key..</li><li>"all": The log system stores all changes including
UPDATE_BEFORE.</li><li>"upsert": The log system does not store the
UPDATE_BEFORE changes, the log consumed job will automatically add the
normalized node, relying on the state to generate the required
update_before.</li></ul><br /><br />Possible values:<ul><li>"auto": Upsert for
tab [...]
+ <td>Specify the log changelog mode for table.<br /><br />Possible
values:<ul><li>"auto": Upsert for table with primary key, all for table without
primary key..</li><li>"all": The log system stores all changes including
UPDATE_BEFORE.</li><li>"upsert": The log system does not store the
UPDATE_BEFORE changes, the log consumed job will automatically add the
normalized node, relying on the state to generate the required
update_before.</li></ul></td>
</tr>
<tr>
<td><h5>log.consistency</h5></td>
<td style="word-wrap: break-word;">transactional</td>
<td><p>Enum</p></td>
- <td>Specify the log consistency mode for table.<br
/><ul><li>"transactional": Only the data after the checkpoint can be seen by
readers, the latency depends on checkpoint interval.</li><li>"eventual":
Immediate data visibility, you may see some intermediate states, but eventually
the right results will be produced, only works for table with primary
key.</li></ul><br /><br />Possible values:<ul><li>"transactional": Only the
data after the checkpoint can be seen by readers, the [...]
+ <td>Specify the log consistency mode for table.<br /><br
/>Possible values:<ul><li>"transactional": Only the data after the checkpoint
can be seen by readers, the latency depends on checkpoint
interval.</li><li>"eventual": Immediate data visibility, you may see some
intermediate states, but eventually the right results will be produced, only
works for table with primary key.</li></ul></td>
</tr>
<tr>
<td><h5>log.format</h5></td>
@@ -90,7 +90,7 @@
<td><h5>log.scan</h5></td>
<td style="word-wrap: break-word;">full</td>
<td><p>Enum</p></td>
- <td>Specify the startup mode for log consumer.<br
/><ul><li>"full": Perform a snapshot on the table upon first startup, and
continue to read the latest changes.</li></ul><ul><li>"latest": Start from the
latest.</li></ul><ul><li>"from-timestamp": Start from user-supplied
timestamp.</li></ul><br /><br />Possible values:<ul><li>"full": Perform a
snapshot on the table upon first startup, and continue to read the latest
changes.</li><li>"latest": Start from the latest.</li><li>"fr [...]
+ <td>Specify the startup mode for log consumer.<br /><br />Possible
values:<ul><li>"full": Perform a snapshot on the table upon first startup, and
continue to read the latest changes.</li><li>"latest": Start from the
latest.</li><li>"from-timestamp": Start from user-supplied
timestamp.</li></ul></td>
</tr>
<tr>
<td><h5>log.scan.timestamp-millis</h5></td>
@@ -120,7 +120,7 @@
<td><h5>merge-engine</h5></td>
<td style="word-wrap: break-word;">deduplicate</td>
<td><p>Enum</p></td>
- <td>Specify the merge engine for table with primary key.<br
/><ul><li>"deduplicate": De-duplicate and keep the last
row.</li><li>"partial-update": Partial update non-null fields.</li></ul><br
/><br />Possible values:<ul><li>"deduplicate": De-duplicate and keep the last
row.</li><li>"partial-update": Partial update non-null fields.</li></ul></td>
+ <td>Specify the merge engine for table with primary key.<br /><br
/>Possible values:<ul><li>"deduplicate": De-duplicate and keep the last
row.</li><li>"partial-update": Partial update non-null fields.</li></ul></td>
</tr>
<tr>
<td><h5>num-levels</h5></td>
@@ -204,7 +204,7 @@
<td><h5>write-mode</h5></td>
<td style="word-wrap: break-word;">change-log</td>
<td><p>Enum</p></td>
- <td>Specify the write mode for table.<br /><ul><li>"append-only":
The table can only accept append-only insert operations. Neither data
deduplication nor any primary key constraints will be done when inserting rows
into table store.</li></ul><ul><li>"change-log": The table can accept
insert/delete/update operations.</li></ul><br /><br />Possible
values:<ul><li>"append-only": The table can only accept append-only insert
operations. Neither data deduplication nor any primary ke [...]
+ <td>Specify the write mode for table.<br /><br />Possible
values:<ul><li>"append-only": The table can only accept append-only insert
operations. Neither data deduplication nor any primary key constraints will be
done when inserting rows into table store.</li><li>"change-log": The table can
accept insert/delete/update operations.</li></ul></td>
</tr>
</tbody>
</table>
diff --git
a/flink-table-store-common/src/main/java/org/apache/flink/table/store/utils/OptionsUtils.java
b/flink-table-store-common/src/main/java/org/apache/flink/table/store/utils/OptionsUtils.java
deleted file mode 100644
index 3436e3cd..00000000
---
a/flink-table-store-common/src/main/java/org/apache/flink/table/store/utils/OptionsUtils.java
+++ /dev/null
@@ -1,32 +0,0 @@
-/*
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. The ASF licenses this file
- * to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance
- * with the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.apache.flink.table.store.utils;
-
-import org.apache.flink.configuration.DescribedEnum;
-import org.apache.flink.configuration.description.TextElement;
-
-import static org.apache.flink.configuration.description.TextElement.text;
-
-/** Utils for options. */
-public class OptionsUtils {
-
- public static TextElement formatEnumOption(DescribedEnum describedEnum) {
- return text("\"%s\": %s", text(describedEnum.toString()),
describedEnum.getDescription());
- }
-}
diff --git
a/flink-table-store-core/src/main/java/org/apache/flink/table/store/CatalogOptions.java
b/flink-table-store-core/src/main/java/org/apache/flink/table/store/CatalogOptions.java
index 925a0d13..26a63fad 100644
---
a/flink-table-store-core/src/main/java/org/apache/flink/table/store/CatalogOptions.java
+++
b/flink-table-store-core/src/main/java/org/apache/flink/table/store/CatalogOptions.java
@@ -35,7 +35,9 @@ public class CatalogOptions {
public static final ConfigOption<String> METASTORE =
ConfigOptions.key("metastore")
.stringType()
- .defaultValue(FileSystemCatalogFactory.IDENTIFIER);
+ .defaultValue(FileSystemCatalogFactory.IDENTIFIER)
+ .withDescription(
+ "Metastore of table store catalog, supports
filesystem and hive.");
public static final ConfigOption<String> URI =
ConfigOptions.key("uri")
diff --git
a/flink-table-store-core/src/main/java/org/apache/flink/table/store/CoreOptions.java
b/flink-table-store-core/src/main/java/org/apache/flink/table/store/CoreOptions.java
index 04a28a96..caa3a43e 100644
---
a/flink-table-store-core/src/main/java/org/apache/flink/table/store/CoreOptions.java
+++
b/flink-table-store-core/src/main/java/org/apache/flink/table/store/CoreOptions.java
@@ -42,7 +42,6 @@ import java.util.Optional;
import static org.apache.flink.configuration.ConfigOptions.key;
import static org.apache.flink.configuration.description.TextElement.text;
-import static org.apache.flink.table.store.utils.OptionsUtils.formatEnumOption;
/** Core options for table store. */
public class CoreOptions implements Serializable {
@@ -140,26 +139,13 @@ public class CoreOptions implements Serializable {
ConfigOptions.key("merge-engine")
.enumType(MergeEngine.class)
.defaultValue(MergeEngine.DEDUPLICATE)
- .withDescription(
- Description.builder()
- .text("Specify the merge engine for table
with primary key.")
- .linebreak()
- .list(
-
formatEnumOption(MergeEngine.DEDUPLICATE),
-
formatEnumOption(MergeEngine.PARTIAL_UPDATE))
- .build());
+ .withDescription("Specify the merge engine for table with
primary key.");
public static final ConfigOption<WriteMode> WRITE_MODE =
ConfigOptions.key("write-mode")
.enumType(WriteMode.class)
.defaultValue(WriteMode.CHANGE_LOG)
- .withDescription(
- Description.builder()
- .text("Specify the write mode for table.")
- .linebreak()
-
.list(formatEnumOption(WriteMode.APPEND_ONLY))
-
.list(formatEnumOption(WriteMode.CHANGE_LOG))
- .build());
+ .withDescription("Specify the write mode for table.");
public static final ConfigOption<MemorySize> SOURCE_SPLIT_TARGET_SIZE =
ConfigOptions.key("source.split.target-size")
@@ -260,14 +246,7 @@ public class CoreOptions implements Serializable {
ConfigOptions.key("log.scan")
.enumType(LogStartupMode.class)
.defaultValue(LogStartupMode.FULL)
- .withDescription(
- Description.builder()
- .text("Specify the startup mode for log
consumer.")
- .linebreak()
-
.list(formatEnumOption(LogStartupMode.FULL))
-
.list(formatEnumOption(LogStartupMode.LATEST))
-
.list(formatEnumOption(LogStartupMode.FROM_TIMESTAMP))
- .build());
+ .withDescription("Specify the startup mode for log
consumer.");
public static final ConfigOption<Long> LOG_SCAN_TIMESTAMP_MILLS =
ConfigOptions.key("log.scan.timestamp-millis")
@@ -287,28 +266,13 @@ public class CoreOptions implements Serializable {
ConfigOptions.key("log.consistency")
.enumType(LogConsistency.class)
.defaultValue(LogConsistency.TRANSACTIONAL)
- .withDescription(
- Description.builder()
- .text("Specify the log consistency mode
for table.")
- .linebreak()
- .list(
-
formatEnumOption(LogConsistency.TRANSACTIONAL),
-
formatEnumOption(LogConsistency.EVENTUAL))
- .build());
+ .withDescription("Specify the log consistency mode for
table.");
public static final ConfigOption<LogChangelogMode> LOG_CHANGELOG_MODE =
ConfigOptions.key("log.changelog-mode")
.enumType(LogChangelogMode.class)
.defaultValue(LogChangelogMode.AUTO)
- .withDescription(
- Description.builder()
- .text("Specify the log changelog mode for
table.")
- .linebreak()
- .list(
-
formatEnumOption(LogChangelogMode.AUTO),
-
formatEnumOption(LogChangelogMode.ALL),
-
formatEnumOption(LogChangelogMode.UPSERT))
- .build());
+ .withDescription("Specify the log changelog mode for
table.");
public static final ConfigOption<String> LOG_KEY_FORMAT =
ConfigOptions.key("log.key.format")
