xxq250
/
homework-jianmu
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

enh: update document format for zh and en

This commit is contained in:
Alex Duan 2024-12-13 21:06:38 +08:00
parent 67eb4451a5
commit fb185da5a1
2 changed files with 47 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
docs/en/10-third-party/05-bi/11-superset.md vendored
View File

@ -1,6 +1,6 @@
--- ---
sidebar_label: SuperSet sidebar_label: Superset
title: Integration With SuperSet title: Integration With Superset
toc_max_heading_level: 4 toc_max_heading_level: 4
--- ---
Apache Superset is a modern enterprise level business intelligence (BI) web application primarily used for data exploration and visualization. Apache Superset is a modern enterprise level business intelligence (BI) web application primarily used for data exploration and visualization.
@ -10,24 +10,24 @@ 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 Through the Python connector of TDengine, Superset can support TDengine data sources and provide functions such as data presentation and analysis
## Install Apache Superset ## 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 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 ## Install TDengine
Both TDengine Enterprise Edition and Community Edition are supported, with version requirements of 3.0 or higher Both TDengine Enterprise Edition and Community Edition are supported, with version requirements of 3.0 or higher
## Install TDengine Python Connector ## Install TDengine Python Connector
The Python connector of TDengine comes with a connection driver that supports SuperSet in versions 2.1.17 and later, which will be automatically installed in the SuperSet directory and provide data source services The Python connector of TDengine comes with a connection driver that supports Superset in versions 2.1.17 and later, which will be automatically installed in the Superset directory and provide data source services
The connection uses the WebSocket protocol, so it is necessary to install the taos ws py component of TDengine separately. The complete installation script is as follows: The connection uses the WebSocket protocol, so it is necessary to install the taos ws py component of TDengine separately. The complete installation script is as follows:
```bash ```bash
pip3 install taospy pip3 install taospy
pip3 install taos-ws-py pip3 install taos-ws-py
``` ```
## Configure TDengine Connection In SuperSet ## Configure TDengine Connection In Superset
Step 1, enter the new database connection page Step 1, enter the new database connection page
SuperSet -> Setting-> Database Connections -> +DATABASE Superset -> Setting-> Database Connections -> +DATABASE
Step 2, select TDengine database connection Step 2, select TDengine database connection
Select the "TDengine" option from the drop-down list of Supported DATABASES. If there is no TDengine option in the drop-down list, please confirm that the steps of installing SuperSet first and then installing the Python connector are correct Select the "TDengine" option from the drop-down list of Supported DATABASES. If there is no TDengine option in the drop-down list, please confirm that the steps of installing Superset first and then installing the Python connector are correct
Step 3, give the connection a name in the PLAY NAME and fill it in freely Step 3, give the connection a name in the PLAY NAME and fill it in freely
Step 4: The SQLALCHEMY URL * field is a key connection information string, and it must be filled in correctly Step 4: The SQLALCHEMY URL * field is a key connection information string, and it must be filled in correctly
```bash ```bash
@ -35,10 +35,10 @@ Step 4: The SQLALCHEMY URL * field is a key connection information string, and i
``` ```
| Parameter | Parameter Description | | Parameter | Parameter Description |
|:---------- |:--------- | |:---------- |:--------- |
|user: | Username for logging into TDengine database | |user | Username for logging into TDengine database |
|password: | Password for logging into TDengine database | |password | Password for logging into TDengine database |
|host: | Name of the host where the TDengine database is located | |host | Name of the host where the TDengine database is located |
|port: | The port that provides WebSocket services, default is 6041 | |port | The port that provides WebSocket services, default is 6041 |
Example: Example:
The TDengine database installed on this machine provides WebSocket service port 6041, using the default username and password, and the connection string is: The TDengine database installed on this machine provides WebSocket service port 6041, using the default username and password, and the connection string is:
@ -50,7 +50,7 @@ Step 5, configure the connection string, click "TEST CONNECTION" to test if the
## Start ## Start
There is no difference in the use of TDengine data source compared to other data sources. Here is a brief introduction to basic data queries: There is no difference in the use of TDengine data source compared to other data sources. Here is a brief introduction to basic data queries:
1. Click the "+" button in the upper right corner of the SuperSet interface, select SQL query, and enter the query interface 1. Click the "+" button in the upper right corner of the Superset interface, select SQL query, and enter the query interface
2. Select the TDengine data source that has been created earlier from the dropdown list in the upper left corner 2. Select the TDengine data source that has been created earlier from the dropdown list in the upper left corner
3. Select the name of the database to be operated on from the drop-down list of schema (system libraries are not displayed) 3. Select the name of the database to be operated on from the drop-down list of schema (system libraries are not displayed)
4. SEE TABLE Schematic: Select the name of the super table or regular table to be operated on (sub tables are not displayed) 4. SEE TABLE Schematic: Select the name of the super table or regular table to be operated on (sub tables are not displayed)
@ -58,7 +58,7 @@ There is no difference in the use of TDengine data source compared to other data
6. In the SQL editor area, any SQL statement that conforms to TDengine syntax can be entered for execution 6. In the SQL editor area, any SQL statement that conforms to TDengine syntax can be entered for execution
## Example ## Example
We chose two popular templates from the SuperSet Chart template to showcase their effects, using smart meter data as an example: We chose two popular templates from the Superset Chart template to showcase their effects, using smart meter data as an example:
The first type is Aggregate, which displays the maximum voltage value collected per minute during the specified time period in Group 4 The first type is Aggregate, which displays the maximum voltage value collected per minute during the specified time period in Group 4

66
docs/zh/10-third-party/05-bi/11-superset.md vendored
View File

@ -1,63 +1,65 @@
--- ---
sidebar_label: SuperSet sidebar_label: Superset
title: 与 SuperSet 的集成 title: 与 Superset 集成
toc_max_heading_level: 4
--- ---
‌Apache Superset‌ 是一个现代的企业级商业智能（BI）Web 应用程序，主要用于数据探索和可视化。它由 Apache 软件基金会支持，是一个开源项目，拥有活跃的社区和丰富的生态系统。Apache Superset 提供了直观的用户界面，使得创建、分享和可视化数据变得简单，同时支持多种数据源和丰富的可视化选项‌。 ‌Apache Superset‌ 是一个现代的企业级商业智能（BI）Web 应用程序，主要用于数据探索和可视化。它由 Apache 软件基金会支持，是一个开源项目，它拥有活跃的社区和丰富的生态系统。Apache Superset 提供了直观的用户界面，使得创建、分享和可视化数据变得简单，同时支持多种数据源和丰富的可视化选项‌。
通过 TDengine 的 Python 连接器, ‌Superset‌ 可支持 TDengine 数据源并提供数据展现、分析等功能 通过 TDengine 的 Python 连接器, ‌Superset‌ 可支持 TDengine 数据源并提供数据展现、分析等功能
## 安装 Apache Superset ## 安装 Apache Superset
确保已安装 Apache SuperSet v2.1.0 及以上版本, 如未安装，请到其 [官网](https://superset.apache.org/) 安装
确保已安装 Apache Superset v2.1.0 及以上版本, 如未安装，请到其 [官网](https://superset.apache.org/) 安装
## 安装 TDengine ## 安装 TDengine
TDengine 企业版及社区版均可支持，版本要求在 3.0 及以上 TDengine 企业版及社区版均可支持，版本要求在 3.0 及以上
## 安装 TDengine Python 连接器 ## 安装 TDengine Python 连接器
TDengine 的 Python 连接器在 v2.1.17 及之后版本中自带支持 SuperSet 的连接驱动，会自动安装到 SuperSet 目录下并提供数据源服务
连接使用 WebSocket 协议，所以需另安装 TDengine 的 taos-ws-py 组件, 全部安装脚本如下： TDengine 的 Python 连接器在 v2.1.17 及之后版本中自带支持 Superset 的连接驱动，安装程序会把驱动安装到 Superset 相应目录下并提供数据源服务
Superset 与 TDengine 之间使用 WebSocket 协议连接，所以需另安装支持 WebSocket 连接协议的组件 `taos-ws-py` , 全部安装脚本如下：
```bash ```bash
pip3 install taospy pip3 install taospy
pip3 install taos-ws-py pip3 install taos-ws-py
``` ```
## SuperSet 中配置 TDengine 连接 ## Superset 中配置 TDengine 连接
第1步，进入新建数据库连接页面
SuperSet -> Setting-> Database Connections -> +DATABASE
第2步，选择 TDengine 数据库连接
SUPPORTED DATABASES 下拉列表中选择 “TDengine” 项，若下拉列表中没有 TDengine 选项，请确认先安装 SuperSet 后安装 Python 连接器的步骤正确
第3步，DISPLAY NAME 中给连接起个名字，任意填写即可
第4步，SQLALCHEMY URL* 项为关键连接信息串，务必填写正确
```bash
连接串格式： taosws://用户名:密码@主机名:端口号
```
| 参数名称 | 参数说明 |
|:------- |:----------------------------- |
| 用户名： | 登录 TDengine 数据库的用户名 |
| 密码： | 登录 TDengine 数据库的密码 |
| 主机名： | TDengine 数据库所在主机的名称 |
| 端口号： | 提供 WebSocket 服务的端口，默认为：6041 |
示例： 第1步，进入新建数据库连接页面 Superset -> Setting-> Database Connections -> +DATABASE
本机安装的 TDengine 数据库，提供 WebSocket 服务端口为 6041，使用默认用户名密码，连接串为： 第2步，选择 TDengine 数据库连接。`SUPPORTED DATABASES` 下拉列表中选择 `TDengine` 项，若下拉列表中无 `TDengine` 项，请检查安装顺序，确保 `TDengine Python 连接器`在 `Superset` 安装之后再安装。
第3步，DISPLAY NAME 中给连接起个名字，任意填写即可。
第4步，SQLALCHEMY URL* 项为关键连接信息串，务必填写正确。
```bash
连接串格式： taosws://用户名:密码@主机名:端口号
```
| 参数名称 | 参数说明 |
|:------- |:-------------------------------- |
| 用户名 | 登录 TDengine 数据库用户名 |
| 密码 | 登录 TDengine 数据库密码 |
| 主机名 | TDengine 数据库所在主机名称 |
| 端口号 | 提供 WebSocket 服务的端口，默认：6041 |
示例：
本机安装 TDengine 数据库，WebSocket 服务端口 6041，使用默认用户名密码，连接串为：
```bash ```bash
taosws://root:taosdata@localhost:6041 taosws://root:taosdata@localhost:6041
``` ```
第5步，配置好连接串，点击 "TEST CONNECTION" 测试连接是否能够成功，测试通过后点 CONNECT 按钮，完成连接 第5步，配置好连接串，点击 `TEST CONNECTION` 测试连接是否成功，测试通过后点击 `CONNECT` 按钮，完成连接。
## 开始使用 ## 开始使用
TDengine 数据源与其它数据源使用上无差别，这里简单介绍下基本数据查询：
1. SuperSet 界面点击右上角 “+” 号按钮，选择 SQL query, 进入查询界面 TDengine 数据源与其它数据源使用上无差别，这里简单介绍下数据查询：
2. 左上角 DATABASE 下拉列表中选择前面已创建好的 TDengine 数据源 1. Superset 界面点击右上角 “+” 号按钮，选择 `SQL query`, 进入查询界面
2. 左上角 DATABASE 下拉列表中选择前面已创建好的 `TDengine` 数据源
3. SCHEMA 下拉列表，选择要操作的数据库名（系统库不显示） 3. SCHEMA 下拉列表，选择要操作的数据库名（系统库不显示）
4. SEE TABLE SCHEMA 选择要操作的超级表名或普通表名（子表不显示） 4. SEE TABLE SCHEMA 选择要操作的超级表名或普通表名（子表不显示）
5. 随后会在下面区域显示选定表的 SCHEMA 信息 5. 随后会在下方显示选定表的 SCHEMA 信息
6. 在 SQL 编辑器区域可输入符合 TDengine 语法的任意 SQL 语句执行 6. 在 SQL 编辑器区域可输入符合 TDengine 语法的任意 SQL 语句执行
## 示例效果 ## 示例效果
我们选择 SuperSet Chart 模板中较流行的两个模板做了效果展示，以智能电表数据为例：
我们选择 Superset Chart 模板中较流行的两个模板做了效果展示，以智能电表数据为例：
第一个为 Aggregate 类型，展示在第 4 组中指定时间段内每分钟采集电压值(voltage) 最大值 第一个为 Aggregate 类型，展示在第 4 组中指定时间段内每分钟采集电压值(voltage) 最大值