(incubator-paimon) branch master updated: [hotfix] Fix doc and improve error message (#2489)

[kerwin]

This is an automated email from the ASF dual-hosted git repository.

kerwin 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 223cccc81 [hotfix] Fix doc and improve error message (#2489)
223cccc81 is described below

commit 223cccc817634fcff045fe77ab40ea46717356f0
Author: yuzelin <33053040+yuze...@users.noreply.github.com>
AuthorDate: Tue Dec 12 16:46:28 2023 +0800

    [hotfix] Fix doc and improve error message (#2489)
---
 docs/content/api/flink-api.md                                       | 4 ++++
 docs/layouts/shortcodes/generated/compute_column.html               | 6 ++++--
 .../org/apache/paimon/flink/action/cdc/MessageQueueSchemaUtils.java | 5 ++++-
 3 files changed, 12 insertions(+), 3 deletions(-)

diff --git a/docs/content/api/flink-api.md b/docs/content/api/flink-api.md
index 6140ba397..d5f17fc4a 100644
--- a/docs/content/api/flink-api.md
+++ b/docs/content/api/flink-api.md
@@ -73,6 +73,8 @@ public class WriteToTable {
     public static void writeTo() {
         // create environments of both APIs
         StreamExecutionEnvironment env = 
StreamExecutionEnvironment.getExecutionEnvironment();
+        // for CONTINUOUS_UNBOUNDED source, set checkpoint interval
+        // env.enableCheckpointing(60_000);
         StreamTableEnvironment tableEnv = StreamTableEnvironment.create(env);
 
         // create a changelog DataStream
@@ -173,6 +175,8 @@ public class WriteCdcToTable {
 
     public static void writeTo() throws Exception {
         StreamExecutionEnvironment env = 
StreamExecutionEnvironment.getExecutionEnvironment();
+        // for CONTINUOUS_UNBOUNDED source, set checkpoint interval
+        // env.enableCheckpointing(60_000);
 
         DataStream<RichCdcRecord> dataStream =
                 env.fromElements(
diff --git a/docs/layouts/shortcodes/generated/compute_column.html 
b/docs/layouts/shortcodes/generated/compute_column.html
index f086c65bc..1bef72340 100644
--- a/docs/layouts/shortcodes/generated/compute_column.html
+++ b/docs/layouts/shortcodes/generated/compute_column.html
@@ -42,8 +42,10 @@ under the License.
         <td>Extract hour from a DATE, DATETIME or TIMESTAMP (or its 
corresponding string format). Output is an INT value represent the hour.</td>
     </tr>
     <tr>
-        <td><h5>date_format(date-column)</h5></td>
-        <td>Convert date format from a DATE, DATETIME or TIMESTAMP (or its 
corresponding string format). Output is a string value in converted date 
format.</td>
+        <td><h5>date_format(date-column,format)</h5></td>
+        <td>Convert date format from a DATE, DATETIME or TIMESTAMP (or its 
corresponding string format).
+            'format' is compatible with Java's DateTimeFormatter String (for 
example, 'yyyy-MM-dd'). Output is a string value in converted date format.
+        </td>
     </tr>
     <tr>
         <td><h5>substring(column,beginInclusive)</h5></td>
diff --git 
a/paimon-flink/paimon-flink-cdc/src/main/java/org/apache/paimon/flink/action/cdc/MessageQueueSchemaUtils.java
 
b/paimon-flink/paimon-flink-cdc/src/main/java/org/apache/paimon/flink/action/cdc/MessageQueueSchemaUtils.java
index 326c73cca..590f63911 100644
--- 
a/paimon-flink/paimon-flink-cdc/src/main/java/org/apache/paimon/flink/action/cdc/MessageQueueSchemaUtils.java
+++ 
b/paimon-flink/paimon-flink-cdc/src/main/java/org/apache/paimon/flink/action/cdc/MessageQueueSchemaUtils.java
@@ -66,7 +66,10 @@ public class MessageQueueSchemaUtils {
             if (retry >= MAX_RETRY) {
                 throw new SchemaRetrievalException(
                         String.format(
-                                "Could not get metadata from server, topic: 
%s", consumer.topic()));
+                                "Could not get metadata from server, topic: 
%s. If this topic is not empty, "
+                                        + "please check the configuration of 
synchronization job. "
+                                        + "Otherwise, you should create the 
Paimon table first.",
+                                consumer.topic()));
             }
 
             sleepSafely(retryInterval);