You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@kyuubi.apache.org by ch...@apache.org on 2023/03/26 10:30:31 UTC

[kyuubi] branch master updated: [KYUUBI #4607] [DOCS] Rename Flink Table Store to Apache Paimon (Incubating) in docs `Connectors for Hive SQL Query Engine`

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 e6aab78f6 [KYUUBI #4607]  [DOCS] Rename Flink Table Store to Apache Paimon (Incubating) in docs `Connectors for Hive SQL Query Engine`
e6aab78f6 is described below

commit e6aab78f65a4badab6ffaea693e8e615284b8688
Author: guanhua.lgh <gu...@alibaba-inc.com>
AuthorDate: Sun Mar 26 18:30:22 2023 +0800

    [KYUUBI #4607]  [DOCS] Rename Flink Table Store to Apache Paimon (Incubating) in docs `Connectors for Hive SQL Query Engine`
    
    ### _Why are the changes needed?_
    
    To update docs.
    Rename Flink Table Store to Apache Paimon (Incubating) and update in docs under `Connectors for Hive 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 #4607 from huage1994/docss.
    
    Closes #4607
    
    695d83772 [guanhua.lgh]  [DOCS] Rename Flink Table Store to Apache Paimon (Incubating) and update in docs under  `Connectors for Hive SQL Query Engine`
    
    Authored-by: guanhua.lgh <gu...@alibaba-inc.com>
    Signed-off-by: Cheng Pan <ch...@apache.org>
---
 docs/connector/hive/index.rst                      |  2 +-
 .../hive/{flink_table_store.rst => paimon.rst}     | 53 +++++++++++-----------
 2 files changed, 27 insertions(+), 28 deletions(-)

diff --git a/docs/connector/hive/index.rst b/docs/connector/hive/index.rst
index 961e1bc8b..d96f8b041 100644
--- a/docs/connector/hive/index.rst
+++ b/docs/connector/hive/index.rst
@@ -19,5 +19,5 @@ Connectors for Hive SQL Query Engine
 .. toctree::
     :maxdepth: 2
 
-    flink_table_store
+    paimon
     iceberg
diff --git a/docs/connector/hive/flink_table_store.rst b/docs/connector/hive/paimon.rst
similarity index 52%
rename from docs/connector/hive/flink_table_store.rst
rename to docs/connector/hive/paimon.rst
index 893262189..000d2d7e8 100644
--- a/docs/connector/hive/flink_table_store.rst
+++ b/docs/connector/hive/paimon.rst
@@ -13,30 +13,29 @@
    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 about Apache Paimon (Incubating) 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
+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
-Hive to manipulate Flink Table Store.
+Hive to manipulate Apache Paimon (Incubating).
 
-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 hive sql engine and Apache Paimon (Incubating), you need to:
 
-- Referencing the Flink Table Store :ref:`dependencies<hive-flink-table-store-deps>`
-- Setting the environment variable :ref:`configurations<hive-flink-table-store-conf>`
+- Referencing the Apache Paimon (Incubating) :ref:`dependencies<hive-paimon-deps>`
+- Setting the environment variable :ref:`configurations<hive-paimon-conf>`
 
-.. _hive-flink-table-store-deps:
+.. _hive-paimon-deps:
 
 Dependencies
 ************
@@ -45,37 +44,37 @@ The **classpath** of kyuubi hive sql engine with Iceberg supported consists of
 
 1. kyuubi-hive-sql-engine-\ |release|\ _2.12.jar, the engine jar deployed with Kyuubi distributions
 2. a copy of hive distribution
-3. flink-table-store-hive-connector-<flink-table-store.version>_<hive.binary.version>.jar (example: flink-table-store-hive-connector-0.4.0_3.1.jar), which can be found in the `Installation Table Store in Hive`_
+3. paimon-hive-connector-<hive.binary.version>-<paimon.version>.jar (example: paimon-hive-connector-3.1-0.4-SNAPSHOT.jar), which can be found in the `Apache Paimon (Incubating) Supported Engines Hive`_
 
 In order to make the Hive packages visible for the runtime classpath of engines, we can use one of these methods:
 
-1. You can create an auxlib folder under the root directory of Hive, and copy flink-table-store-hive-connector-0.4.0_3.1.jar into auxlib.
+1. You can create an auxlib folder under the root directory of Hive, and copy paimon-hive-connector-3.1-<paimon.version>.jar into auxlib.
 2. Execute ADD JAR statement in the Kyuubi to add dependencies to Hive’s auxiliary classpath. For example:
 
 .. code-block:: sql
 
-   ADD JAR /path/to/flink-table-store-hive-connector-0.4.0_3.1.jar;
+   ADD JAR /path/to/paimon-hive-connector-3.1-<paimon.version>.jar;
 
 .. warning::
     The second method is not recommended. If you’re using the MR execution engine and running a join statement, you may be faced with the exception
     ``org.apache.hive.com.esotericsoftware.kryo.kryoexception: unable to find class.``
 
 .. warning::
-   Please mind the compatibility of different Flink Table Store and Hive 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 Hive versions, which can be confirmed on the page of `Apache Paimon (Incubating) multi engine support`_.
 
-.. _hive-flink-table-store-conf:
+.. _hive-paimon-conf:
 
 Configurations
 **************
 
 If you are using HDFS, make sure that the environment variable HADOOP_HOME or HADOOP_CONF_DIR is set.
 
-Flink Table Store  Operations
+Apache Paimon (Incubating)  Operations
 ------------------
 
-Flink Table Store only supports only reading table store tables through Hive.
-A common scenario is to write data with Flink and read data with Hive.
-You can follow this document `Flink Table Store Quick Start`_  to write data to a table store table
+Apache Paimon (Incubating) only supports only reading table store tables through Hive.
+A common scenario is to write data with Spark or Flink and read data with Hive.
+You can follow this document `Apache Paimon (Incubating) Quick Start with Paimon Hive Catalog`_  to write data to a table which can also be accessed directly from Hive.
 and then use Kyuubi Hive SQL engine to query the table with the following SQL ``SELECT`` statement.
 
 Taking ``Query Data`` as an example,
@@ -89,13 +88,13 @@ Taking ``Query External Table`` as an example,
 .. code-block:: sql
 
     CREATE EXTERNAL TABLE external_test_table
-    STORED BY 'org.apache.flink.table.store.hive.TableStoreHiveStorageHandler'
+    STORED BY 'org.apache.paimon.hive.PaimonStorageHandler'
     LOCATION '/path/to/table/store/warehouse/default.db/test_table';
 
     SELECT a, b FROM test_table ORDER BY a;
 
-.. _Flink Table Store: https://nightlies.apache.org/flink/flink-table-store-docs-stable/
-.. _Flink Table Store Quick Start: https://nightlies.apache.org/flink/flink-table-store-docs-stable/docs/try-table-store/quick-start/
-.. _Official Documentation: https://nightlies.apache.org/flink/flink-table-store-docs-release-0.4/docs/engines/hive/
-.. _Installation Table Store in Hive: https://nightlies.apache.org/flink/flink-table-store-docs-release-0.4/docs/engines/hive/#installation
-.. _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) Quick Start with Paimon Hive Catalog: https://paimon.apache.org/docs/master/engines/hive/#quick-start-with-paimon-hive-catalog
+.. _Apache Paimon (Incubating) Supported Engines Hive: https://paimon.apache.org/docs/master/engines/hive/
+.. _Apache Paimon (Incubating) multi engine support: https://paimon.apache.org/docs/master/engines/overview/