From b19a08c8dd5e4a5630b1bbc58a8d3ab81f2b0bd7 Mon Sep 17 00:00:00 2001 From: Alex Duan <417921451@qq.com> Date: Fri, 20 Dec 2024 11:29:00 +0800 Subject: [PATCH 01/12] fix: adjust superset doc area block --- docs/zh/10-third-party/05-bi/11-superset.md | 23 ++++++++++++--------- 1 file changed, 13 insertions(+), 10 deletions(-) diff --git a/docs/zh/10-third-party/05-bi/11-superset.md b/docs/zh/10-third-party/05-bi/11-superset.md index 5e6252ced0..2098faf157 100644 --- a/docs/zh/10-third-party/05-bi/11-superset.md +++ b/docs/zh/10-third-party/05-bi/11-superset.md @@ -4,18 +4,19 @@ title: 与 Superset 集成 --- ‌Apache Superset‌ 是一个现代的企业级商业智能（BI）Web 应用程序，主要用于数据探索和可视化。它由 Apache 软件基金会支持，是一个开源项目，它拥有活跃的社区和丰富的生态系统。Apache Superset 提供了直观的用户界面，使得创建、分享和可视化数据变得简单，同时支持多种数据源和丰富的可视化选项‌。 -通过 TDengine 的 Python 连接器, ‌Superset‌ 可支持 TDengine 数据源并提供数据展现、分析等功能 +通过 TDengine 的 Python 连接器, ‌Apache ‌Superset‌ 可支持 TDengine 数据源并提供数据展现、分析等功能 -## 安装 Apache Superset -确保已安装 Apache Superset v2.1.0 及以上版本, 如未安装，请到其 [官网](https://superset.apache.org/) 安装 +## 前置条件 +使 TDengine 成为 Apache Superset 数据源，需以下几方面准备工作： +- TDengine 集群已部署并正常运行（企业及社区版均可） +- taosAdapter 已安装并正常运行。细节请参考 [taosAdapter 的使用手册](../../../reference/components/taosadapter) +- Apache Superset 已安装(要求 v2.1.0 及以上版本)。安装 Apache Superset 请参考[官方文档](https://superset.apache.org/) -## 安装 TDengine -TDengine 企业版及社区版均可支持，版本要求在 3.0 及以上 - -## 安装 TDengine Python 连接器 +## 安装 +#### 安装 TDengine Python 连接器 TDengine Python 连接器从 `v2.1.18` 开始自带 Superset 连接驱动，安装程序会把连接驱动安装到 Superset 相应目录下并向 Superset 提供数据源服务 Superset 与 TDengine 之间使用 WebSocket 协议连接，所以需另安装支持 WebSocket 连接协议的组件 `taos-ws-py` , 全部安装脚本如下： ```bash @@ -23,7 +24,9 @@ pip3 install taospy pip3 install taos-ws-py ``` -## Superset 中配置 TDengine 连接 +## 配置 + +#### Superset 中配置 TDengine 连接 **第 1 步**，进入新建数据库连接页面 "Superset" → "Setting" → "Database Connections" → "+DATABASE" **第 2 步**，选择 TDengine 数据库连接。"SUPPORTED DATABASES" 下拉列表中选择 "TDengine" 项。 @@ -50,7 +53,7 @@ taosws://root:taosdata@localhost:6041 **第 5 步**，配置好连接串，点击 “TEST CONNECTION” 测试连接是否成功，测试通过后点击 “CONNECT” 按钮，完成连接。 -## 开始使用 +## 使用 TDengine 数据源与其它数据源使用上无差别，这里简单介绍下数据查询： 1. Superset 界面点击右上角 “+” 号按钮，选择 “SQL query”, 进入查询界面 @@ -60,7 +63,7 @@ TDengine 数据源与其它数据源使用上无差别，这里简单介绍下 5. 随后会在下方显示选定表的 SCHEMA 信息 6. 在 SQL 编辑器区域可输入符合 TDengine 语法的任意 SQL 语句执行 -## 示例效果 +## 示例 我们选择 Superset Chart 模板中较流行的两个模板做了效果展示，以智能电表数据为例： From 278b758aae24c2166aae9732132540a4b325c28d Mon Sep 17 00:00:00 2001 From: Alex Duan <417921451@qq.com> Date: Fri, 20 Dec 2024 11:43:52 +0800 Subject: [PATCH 02/12] fix: adjust some words --- docs/zh/10-third-party/05-bi/11-superset.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/zh/10-third-party/05-bi/11-superset.md b/docs/zh/10-third-party/05-bi/11-superset.md index 2098faf157..bf7774e3e7 100644 --- a/docs/zh/10-third-party/05-bi/11-superset.md +++ b/docs/zh/10-third-party/05-bi/11-superset.md @@ -10,15 +10,15 @@ title: 与 Superset 集成 ## 前置条件 使 TDengine 成为 Apache Superset 数据源，需以下几方面准备工作： - TDengine 集群已部署并正常运行（企业及社区版均可） -- taosAdapter 已安装并正常运行。细节请参考 [taosAdapter 的使用手册](../../../reference/components/taosadapter) -- Apache Superset 已安装(要求 v2.1.0 及以上版本)。安装 Apache Superset 请参考[官方文档](https://superset.apache.org/) +- taosAdapter 已安装并正常运行。详细参考 [taosAdapter 的使用手册](../../../reference/components/taosadapter) +- Apache Superset v2.1.0 或以上版本已安装。安装 Apache Superset 请参考[官方文档](https://superset.apache.org/) ## 安装 #### 安装 TDengine Python 连接器 -TDengine Python 连接器从 `v2.1.18` 开始自带 Superset 连接驱动，安装程序会把连接驱动安装到 Superset 相应目录下并向 Superset 提供数据源服务 -Superset 与 TDengine 之间使用 WebSocket 协议连接，所以需另安装支持 WebSocket 连接协议的组件 `taos-ws-py` , 全部安装脚本如下： +TDengine Python 连接器从 `v2.1.18` 起带 Superset 连接驱动，安装程序安装此驱动至 Superset 相应目录下并向 Superset 提供数据源服务 +Superset 与 TDengine 之间使用 WebSocket 协议连接，另需安装支持此协议的 `taos-ws-py` 组件, 全部安装脚本如下： ```bash pip3 install taospy pip3 install taos-ws-py From 7605bd90d8cca959c3af5fc7071135c87bb024df Mon Sep 17 00:00:00 2001 From: Alex Duan <417921451@qq.com> Date: Fri, 20 Dec 2024 12:34:34 +0800 Subject: [PATCH 03/12] fix: simple setup superset driver describle --- docs/zh/10-third-party/05-bi/11-superset.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/zh/10-third-party/05-bi/11-superset.md b/docs/zh/10-third-party/05-bi/11-superset.md index bf7774e3e7..87f34118e1 100644 --- a/docs/zh/10-third-party/05-bi/11-superset.md +++ b/docs/zh/10-third-party/05-bi/11-superset.md @@ -17,7 +17,7 @@ title: 与 Superset 集成 ## 安装 #### 安装 TDengine Python 连接器 -TDengine Python 连接器从 `v2.1.18` 起带 Superset 连接驱动，安装程序安装此驱动至 Superset 相应目录下并向 Superset 提供数据源服务 +TDengine Python 连接器从 `v2.1.18` 起带 Superset 连接驱动，会安装至 Superset 相应目录下并向 Superset 提供数据源服务 Superset 与 TDengine 之间使用 WebSocket 协议连接，另需安装支持此协议的 `taos-ws-py` 组件, 全部安装脚本如下： ```bash pip3 install taospy From 94977f9983203ec58000d82e08437d5db4e0cadb Mon Sep 17 00:00:00 2001 From: Alex Duan <417921451@qq.com> Date: Fri, 20 Dec 2024 12:37:10 +0800 Subject: [PATCH 04/12] fix: simple setup superset driver describle1 --- docs/zh/10-third-party/05-bi/11-superset.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/zh/10-third-party/05-bi/11-superset.md b/docs/zh/10-third-party/05-bi/11-superset.md index 87f34118e1..07f8554d03 100644 --- a/docs/zh/10-third-party/05-bi/11-superset.md +++ b/docs/zh/10-third-party/05-bi/11-superset.md @@ -18,7 +18,7 @@ title: 与 Superset 集成 #### 安装 TDengine Python 连接器 TDengine Python 连接器从 `v2.1.18` 起带 Superset 连接驱动，会安装至 Superset 相应目录下并向 Superset 提供数据源服务 -Superset 与 TDengine 之间使用 WebSocket 协议连接，另需安装支持此协议的 `taos-ws-py` 组件, 全部安装脚本如下： +Superset 与 TDengine 之间使用 WebSocket 协议连接，需安装支持此协议的 `taos-ws-py` 组件, 全部安装脚本如下： ```bash pip3 install taospy pip3 install taos-ws-py From 1b366c4898031af6b13db5a5fec84d6c619748da Mon Sep 17 00:00:00 2001 From: Alex Duan <417921451@qq.com> Date: Fri, 20 Dec 2024 13:31:44 +0800 Subject: [PATCH 05/12] add blank --- docs/zh/10-third-party/05-bi/11-superset.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/zh/10-third-party/05-bi/11-superset.md b/docs/zh/10-third-party/05-bi/11-superset.md index 07f8554d03..e8b4f96a33 100644 --- a/docs/zh/10-third-party/05-bi/11-superset.md +++ b/docs/zh/10-third-party/05-bi/11-superset.md @@ -11,7 +11,7 @@ title: 与 Superset 集成 使 TDengine 成为 Apache Superset 数据源，需以下几方面准备工作： - TDengine 集群已部署并正常运行（企业及社区版均可） - taosAdapter 已安装并正常运行。详细参考 [taosAdapter 的使用手册](../../../reference/components/taosadapter) -- Apache Superset v2.1.0 或以上版本已安装。安装 Apache Superset 请参考[官方文档](https://superset.apache.org/) +- Apache Superset v2.1.0 或以上版本已安装。安装 Apache Superset 请参考 [官方文档](https://superset.apache.org/) ## 安装 From 6d4b332aa245b0b178ed760c8f3241c56e5422af Mon Sep 17 00:00:00 2001 From: Alex Duan <417921451@qq.com> Date: Fri, 20 Dec 2024 14:59:49 +0800 Subject: [PATCH 06/12] fix: adjust to docs --- docs/zh/10-third-party/05-bi/11-superset.md | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) diff --git a/docs/zh/10-third-party/05-bi/11-superset.md b/docs/zh/10-third-party/05-bi/11-superset.md index e8b4f96a33..3718fe06d5 100644 --- a/docs/zh/10-third-party/05-bi/11-superset.md +++ b/docs/zh/10-third-party/05-bi/11-superset.md @@ -8,15 +8,14 @@ title: 与 Superset 集成 ## 前置条件 -使 TDengine 成为 Apache Superset 数据源，需以下几方面准备工作： +Apache Superset 连接 TDengine 数据源，需以下几方面准备工作： - TDengine 集群已部署并正常运行（企业及社区版均可） - taosAdapter 已安装并正常运行。详细参考 [taosAdapter 的使用手册](../../../reference/components/taosadapter) - Apache Superset v2.1.0 或以上版本已安装。安装 Apache Superset 请参考 [官方文档](https://superset.apache.org/) -## 安装 +## 安装 TDengine Python 连接器 -#### 安装 TDengine Python 连接器 TDengine Python 连接器从 `v2.1.18` 起带 Superset 连接驱动，会安装至 Superset 相应目录下并向 Superset 提供数据源服务 Superset 与 TDengine 之间使用 WebSocket 协议连接，需安装支持此协议的 `taos-ws-py` 组件, 全部安装脚本如下： ```bash @@ -24,9 +23,7 @@ pip3 install taospy pip3 install taos-ws-py ``` -## 配置 - -#### Superset 中配置 TDengine 连接 +## 配置 TDengine 数据源 **第 1 步**，进入新建数据库连接页面 "Superset" → "Setting" → "Database Connections" → "+DATABASE" **第 2 步**，选择 TDengine 数据库连接。"SUPPORTED DATABASES" 下拉列表中选择 "TDengine" 项。 @@ -53,7 +50,7 @@ taosws://root:taosdata@localhost:6041 **第 5 步**，配置好连接串，点击 “TEST CONNECTION” 测试连接是否成功，测试通过后点击 “CONNECT” 按钮，完成连接。 -## 使用 +## 开始使用 TDengine 数据源与其它数据源使用上无差别，这里简单介绍下数据查询： 1. Superset 界面点击右上角 “+” 号按钮，选择 “SQL query”, 进入查询界面 @@ -63,7 +60,7 @@ TDengine 数据源与其它数据源使用上无差别，这里简单介绍下 5. 随后会在下方显示选定表的 SCHEMA 信息 6. 在 SQL 编辑器区域可输入符合 TDengine 语法的任意 SQL 语句执行 -## 示例 +## 示例效果 我们选择 Superset Chart 模板中较流行的两个模板做了效果展示，以智能电表数据为例： From 089908867b231b9e7428107621769ff783c26557 Mon Sep 17 00:00:00 2001 From: Alex Duan <417921451@qq.com> Date: Fri, 20 Dec 2024 15:10:49 +0800 Subject: [PATCH 07/12] fix: doc1 ready env --- docs/zh/10-third-party/05-bi/11-superset.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/zh/10-third-party/05-bi/11-superset.md b/docs/zh/10-third-party/05-bi/11-superset.md index 3718fe06d5..23eccbc46c 100644 --- a/docs/zh/10-third-party/05-bi/11-superset.md +++ b/docs/zh/10-third-party/05-bi/11-superset.md @@ -8,7 +8,7 @@ title: 与 Superset 集成 ## 前置条件 -Apache Superset 连接 TDengine 数据源，需以下几方面准备工作： +准备以下环境： - TDengine 集群已部署并正常运行（企业及社区版均可） - taosAdapter 已安装并正常运行。详细参考 [taosAdapter 的使用手册](../../../reference/components/taosadapter) - Apache Superset v2.1.0 或以上版本已安装。安装 Apache Superset 请参考 [官方文档](https://superset.apache.org/) From 9382d984bdc11210cf74e4166a6fec9e68c57206 Mon Sep 17 00:00:00 2001 From: Alex Duan <417921451@qq.com> Date: Fri, 20 Dec 2024 15:11:40 +0800 Subject: [PATCH 08/12] fix: doc1 ready env --- docs/zh/10-third-party/05-bi/11-superset.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/zh/10-third-party/05-bi/11-superset.md b/docs/zh/10-third-party/05-bi/11-superset.md index 23eccbc46c..5d6885c2d2 100644 --- a/docs/zh/10-third-party/05-bi/11-superset.md +++ b/docs/zh/10-third-party/05-bi/11-superset.md @@ -8,6 +8,7 @@ title: 与 Superset 集成 ## 前置条件 + 准备以下环境： - TDengine 集群已部署并正常运行（企业及社区版均可） - taosAdapter 已安装并正常运行。详细参考 [taosAdapter 的使用手册](../../../reference/components/taosadapter) From aa92fe3569bbeafccc8f6faccc05110c6994a460 Mon Sep 17 00:00:00 2001 From: Alex Duan <417921451@qq.com> Date: Fri, 20 Dec 2024 16:17:51 +0800 Subject: [PATCH 09/12] submit english doc --- docs/en/10-third-party/05-bi/11-superset.md | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/docs/en/10-third-party/05-bi/11-superset.md b/docs/en/10-third-party/05-bi/11-superset.md index aa56648b99..e4ed49706d 100644 --- a/docs/en/10-third-party/05-bi/11-superset.md +++ b/docs/en/10-third-party/05-bi/11-superset.md @@ -9,14 +9,13 @@ Apache Superset provides an intuitive user interface that makes creating, sharin Through the Python connector of TDengine, Superset can support TDengine data sources and provide functions such as data presentation and analysis -## Install Apache Superset - -Ensure that Apache Superset v2.1.0 or above is installed. If not, please visit [official website](https://superset.apache.org/) to install - -## Install TDengine - -Both TDengine Enterprise Edition and Community Edition are supported, with version requirements of 3.0 or higher +## Prerequisites +Prepare the following environment: +- TDengine cluster has been deployed and is running normally (both Enterprise and Community versions are available) +- taosAdapter is installed and running normally, refer to [taosAdapter](../../../reference/components/taosAdapter) +- Apache Superset version 2.1.0 or above is already installed, refre to [Apache Superset](https://superset.apache.org/) + ## Install TDengine Python Connector The Python connector of TDengine comes with a connection driver that supports Superset in versions 2.1.18 and later, which will be automatically installed in the Superset directory and provide data source services. From 08030bac6ee5b387862a13f3785d272d8475e558 Mon Sep 17 00:00:00 2001 From: Alex Duan <417921451@qq.com> Date: Fri, 20 Dec 2024 16:30:27 +0800 Subject: [PATCH 10/12] fix: english doc with superset --- docs/en/10-third-party/05-bi/11-superset.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/en/10-third-party/05-bi/11-superset.md b/docs/en/10-third-party/05-bi/11-superset.md index e4ed49706d..be3e3aa08d 100644 --- a/docs/en/10-third-party/05-bi/11-superset.md +++ b/docs/en/10-third-party/05-bi/11-superset.md @@ -12,8 +12,8 @@ Through the Python connector of TDengine, Superset can support TDengine data sou ## Prerequisites Prepare the following environment: -- TDengine cluster has been deployed and is running normally (both Enterprise and Community versions are available) -- taosAdapter is installed and running normally, refer to [taosAdapter](../../../reference/components/taosAdapter) +- TDengine is installed and running normally (both Enterprise and Community versions are available) +- taosAdapter is running normally, refer to [taosAdapter](../../../reference/components/taosAdapter) - Apache Superset version 2.1.0 or above is already installed, refre to [Apache Superset](https://superset.apache.org/) ## Install TDengine Python Connector From a5c2df7584a7fc8d347babd80a8e991485e10e4c Mon Sep 17 00:00:00 2001 From: Alex Duan <417921451@qq.com> Date: Fri, 20 Dec 2024 17:03:56 +0800 Subject: [PATCH 11/12] fix: remove adapter install because already install --- docs/zh/10-third-party/05-bi/11-superset.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/zh/10-third-party/05-bi/11-superset.md b/docs/zh/10-third-party/05-bi/11-superset.md index 5d6885c2d2..1fc2096659 100644 --- a/docs/zh/10-third-party/05-bi/11-superset.md +++ b/docs/zh/10-third-party/05-bi/11-superset.md @@ -11,7 +11,7 @@ title: 与 Superset 集成 准备以下环境： - TDengine 集群已部署并正常运行（企业及社区版均可） -- taosAdapter 已安装并正常运行。详细参考 [taosAdapter 的使用手册](../../../reference/components/taosadapter) +- taosAdapter 能够正常运行。详细参考 [taosAdapter 的使用手册](../../../reference/components/taosadapter) - Apache Superset v2.1.0 或以上版本已安装。安装 Apache Superset 请参考 [官方文档](https://superset.apache.org/) From 3a5ed28b2a963751d0c7e01d204454e7eaed86b5 Mon Sep 17 00:00:00 2001 From: Alex Duan <417921451@qq.com> Date: Sat, 21 Dec 2024 21:51:03 +0800 Subject: [PATCH 12/12] fix: remove de word for taosadapter doc --- docs/zh/10-third-party/05-bi/11-superset.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/zh/10-third-party/05-bi/11-superset.md b/docs/zh/10-third-party/05-bi/11-superset.md index 1fc2096659..337fc53825 100644 --- a/docs/zh/10-third-party/05-bi/11-superset.md +++ b/docs/zh/10-third-party/05-bi/11-superset.md @@ -11,7 +11,7 @@ title: 与 Superset 集成 准备以下环境： - TDengine 集群已部署并正常运行（企业及社区版均可） -- taosAdapter 能够正常运行。详细参考 [taosAdapter 的使用手册](../../../reference/components/taosadapter) +- taosAdapter 能够正常运行。详细参考 [taosAdapter 使用手册](../../../reference/components/taosadapter) - Apache Superset v2.1.0 或以上版本已安装。安装 Apache Superset 请参考 [官方文档](https://superset.apache.org/)