This is an automated email from the ASF dual-hosted git repository.
chengpan pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/kyuubi.git
The following commit(s) were added to refs/heads/master by this push:
new 932f7ab92 [KYUUBI #4614] [DOCS] Rename Flink Table Store to Apache
Paimon (Incubating) in docs `Connectors for Flink SQL Query Engine`
932f7ab92 is described below
commit 932f7ab926ee5b6760306f446b511da4328108d2
Author: guanhua.lgh <guanhua....@alibaba-inc.com>
AuthorDate: Mon Mar 27 13:04:42 2023 +0800
[KYUUBI #4614] [DOCS] Rename Flink Table Store to Apache Paimon
(Incubating) in docs `Connectors for Flink SQL Query Engine`
### _Why are the changes needed?_
To update docs.
Rename Flink Table Store to Apache Paimon (Incubating) in docs `Connectors
for Flink SQL Query Engine`
### _How was this patch tested?_
- [ ] Add some test cases that check the changes thoroughly including
negative and positive cases if possible
- [ ] Add screenshots for manual tests if appropriate
- [ ] [Run
test](https://kyuubi.readthedocs.io/en/master/develop_tools/testing.html#running-tests)
locally before make a pull request
Closes #4614 from huage1994/docs3.
Closes #4614
50f8b2c6f [Kent Yao] Update docs/connector/flink/paimon.rst
2b34c4724 [guanhua.lgh] typos
7d6488351 [guanhua.lgh] [DOCS] Rename Flink Table Store to Apache Paimon
(Incubating) in docs under `Connectors for Flink SQL Query Engine`
Lead-authored-by: guanhua.lgh <guanhua....@alibaba-inc.com>
Co-authored-by: Kent Yao <y...@apache.org>
Signed-off-by: Cheng Pan <cheng...@apache.org>
---
docs/connector/flink/index.rst | 2 +-
.../flink/{flink_table_store.rst => paimon.rst} | 55 +++++++++++-----------
2 files changed, 28 insertions(+), 29 deletions(-)
diff --git a/docs/connector/flink/index.rst b/docs/connector/flink/index.rst
index c9d91091f..e7d40fd43 100644
--- a/docs/connector/flink/index.rst
+++ b/docs/connector/flink/index.rst
@@ -19,6 +19,6 @@ Connectors For Flink SQL Query Engine
.. toctree::
:maxdepth: 2
- flink_table_store
+ paimon
hudi
iceberg
diff --git a/docs/connector/flink/flink_table_store.rst
b/docs/connector/flink/paimon.rst
similarity index 51%
rename from docs/connector/flink/flink_table_store.rst
rename to docs/connector/flink/paimon.rst
index 14c576bf3..b67101488 100644
--- a/docs/connector/flink/flink_table_store.rst
+++ b/docs/connector/flink/paimon.rst
@@ -13,57 +13,56 @@
See the License for the specific language governing permissions and
limitations under the License.
-`Flink Table Store`_
-==========
+`Apache Paimon (Incubating)`_
+=============================
-Flink Table Store is a unified storage to build dynamic tables for both
streaming and batch processing in Flink,
-supporting high-speed data ingestion and timely data query.
+Apache Paimon (Incubating) is a streaming data lake platform that supports
high-speed data ingestion, change data tracking, and efficient real-time
analytics.
.. tip::
- This article assumes that you have mastered the basic knowledge and
operation of `Flink Table Store`_.
- For the knowledge about Flink Table Store not mentioned in this article,
+ This article assumes that you have mastered the basic knowledge and
operation of `Apache Paimon (Incubating)`_.
+ For the knowledge not mentioned in this article,
you can obtain it from its `Official Documentation`_.
-By using kyuubi, we can run SQL queries towards Flink Table Store which is more
-convenient, easy to understand, and easy to expand than directly using
-flink to manipulate Flink Table Store.
+By using kyuubi, we can run SQL queries towards Apache Paimon (Incubating)
which is more
+convenient, easy to understand, and easy to expand than directly using flink.
-Flink Table Store Integration
--------------------
+Apache Paimon (Incubating) Integration
+--------------------------------------
-To enable the integration of kyuubi flink sql engine and Flink Table Store,
you need to:
+To enable the integration of kyuubi flink sql engine and Apache Paimon
(Incubating), you need to:
-- Referencing the Flink Table Store :ref:`dependencies<flink-table-store-deps>`
+- Referencing the Apache Paimon (Incubating)
:ref:`dependencies<flink-paimon-deps>`
-.. _flink-table-store-deps:
+.. _flink-paimon-deps:
Dependencies
************
-The **classpath** of kyuubi flink sql engine with Flink Table Store supported
consists of
+The **classpath** of kyuubi flink sql engine with Apache Paimon (Incubating)
supported consists of
1. kyuubi-flink-sql-engine-\ |release|\ _2.12.jar, the engine jar deployed
with Kyuubi distributions
2. a copy of flink distribution
-3. flink-table-store-dist-<version>.jar (example:
flink-table-store-dist-0.2.jar), which can be found in the `Maven Central`_
+3. paimon-flink-<version>.jar (example: paimon-flink-1.16-0.4-SNAPSHOT.jar),
which can be found in the `Apache Paimon (Incubating) Supported Engines Flink`_
+4. flink-shaded-hadoop-2-uber-<version>.jar, which code can be found in the
`Pre-bundled Hadoop Jar`_
-In order to make the Flink Table Store packages visible for the runtime
classpath of engines, we can use these methods:
+In order to make the Apache Paimon (Incubating) packages visible for the
runtime classpath of engines, you need to:
-1. Put the Flink Table Store packages into ``$FLINK_HOME/lib`` directly
+1. Put the Apache Paimon (Incubating) packages into ``$FLINK_HOME/lib``
directly
2. Setting the HADOOP_CLASSPATH environment variable or copy the `Pre-bundled
Hadoop Jar`_ to flink/lib.
.. warning::
- Please mind the compatibility of different Flink Table Store and Flink
versions, which can be confirmed on the page of `Flink Table Store multi engine
support`_.
+ Please mind the compatibility of different Apache Paimon (Incubating) and
Flink versions, which can be confirmed on the page of `Apache Paimon
(Incubating) multi engine support`_.
-Flink Table Store Operations
-------------------
+Apache Paimon (Incubating) Operations
+-------------------------------------
Taking ``CREATE CATALOG`` as a example,
.. code-block:: sql
CREATE CATALOG my_catalog WITH (
- 'type'='table-store',
- 'warehouse'='hdfs://nn:8020/warehouse/path' -- or 'file:///tmp/foo/bar'
+ 'type'='paimon',
+ 'warehouse'='file:/tmp/paimon'
);
USE CATALOG my_catalog;
@@ -104,8 +103,8 @@ Taking ``Rescale Bucket`` as a example,
INSERT OVERWRITE my_table PARTITION (dt = '2022-01-01');
-.. _Flink Table Store:
https://nightlies.apache.org/flink/flink-table-store-docs-stable/
-.. _Official Documentation:
https://nightlies.apache.org/flink/flink-table-store-docs-stable/
-.. _Maven Central:
https://mvnrepository.com/artifact/org.apache.flink/flink-table-store-dist
-.. _Pre-bundled Hadoop Jar: https://flink.apache.org/downloads.html
-.. _Flink Table Store multi engine support:
https://nightlies.apache.org/flink/flink-table-store-docs-stable/docs/engines/overview/
+.. _Apache Paimon (Incubating): https://paimon.apache.org/
+.. _Official Documentation: https://paimon.apache.org/docs/master/
+.. _Apache Paimon (Incubating) Supported Engines Flink:
https://paimon.apache.org/docs/master/engines/flink/#preparing-paimon-jar-file
+.. _Pre-bundled Hadoop Jar:
https://flink.apache.org/downloads/#additional-components
+.. _Apache Paimon (Incubating) multi engine support:
https://paimon.apache.org/docs/master/engines/overview/
