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 模板中较流行的两个模板做了效果展示，以智能电表数据为例：