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 2449c326f [doc] Do not recommend using API way
2449c326f is described below
commit 2449c326f4440ecfe31f9f4592f5c64270962244
Author: Jingsong <[email protected]>
AuthorDate: Wed Dec 20 16:48:36 2023 +0800
[doc] Do not recommend using API way
---
docs/content/api/flink-api.md | 8 ++++++++
docs/content/api/java-api.md | 8 ++++++++
2 files changed, 16 insertions(+)
diff --git a/docs/content/api/flink-api.md b/docs/content/api/flink-api.md
index 19ee934f6..942208e1a 100644
--- a/docs/content/api/flink-api.md
+++ b/docs/content/api/flink-api.md
@@ -26,6 +26,14 @@ under the License.
# Flink API
+{{< hint warning >}}
+We do not recommend using programming API. Paimon is designed for SQL first,
unless you are a professional Flink developer, even if you do, it can be very
difficult.
+
+We strongly recommend that you use Flink SQL or Spark SQL, or simply use SQL
APIs in programs.
+
+The following documents are not detailed and are for reference only.
+{{< /hint >}}
+
## Dependency
Maven dependency:
diff --git a/docs/content/api/java-api.md b/docs/content/api/java-api.md
index 230323888..275d84625 100644
--- a/docs/content/api/java-api.md
+++ b/docs/content/api/java-api.md
@@ -26,6 +26,14 @@ under the License.
# Java API
+{{< hint warning >}}
+We do not recommend using the Paimon API naked, unless you are a professional
downstream ecosystem developer, and even if you do, there will be significant
difficulties.
+
+If you are only using Paimon, we strongly recommend using computing engines
such as Flink SQL or Spark SQL.
+
+The following documents are not detailed and are for reference only.
+{{< /hint >}}
+
## Dependency
Maven dependency:
