From aa33cf7456b764fa02c8d9f9b0fe9fafe0e6c03d Mon Sep 17 00:00:00 2001 From: kevin men Date: Tue, 25 Feb 2025 15:18:34 +0800 Subject: [PATCH] docs: update document structure of seeq/tableau/superset (#29920) * docs: adjust the document directory structure * docs: change chapter name * docs: modify the structure of the superset document * docs: modify the title of superset. * docs: adjusting the superset directory and correcting title errors * docs: Correct spelling errors * docs: delete empty rows from the ordered list * docs: modify the format of ordered sequences --- docs/en/10-third-party/05-bi/09-seeq.md | 16 ++-- docs/en/10-third-party/05-bi/11-superset.md | 71 +++++++++--------- docs/zh/10-third-party/05-bi/05-yhbi.md | 2 +- docs/zh/10-third-party/05-bi/09-seeq.md | 16 ++-- docs/zh/10-third-party/05-bi/11-superset.md | 82 +++++++++++---------- docs/zh/10-third-party/05-bi/12-tableau.md | 2 +- 6 files changed, 94 insertions(+), 95 deletions(-) diff --git a/docs/en/10-third-party/05-bi/09-seeq.md b/docs/en/10-third-party/05-bi/09-seeq.md index ba33d801a9..2010ffcbe2 100644 --- a/docs/en/10-third-party/05-bi/09-seeq.md +++ b/docs/en/10-third-party/05-bi/09-seeq.md @@ -22,8 +22,6 @@ Through the `TDengine Java connector`, Seeq can easily support querying time-ser ## Configure Data Source -### Configuration of JDBC Connector - **Step 1**, Check the data storage location ```shell @@ -42,9 +40,13 @@ sudo seeq restart Use a browser to visit ip:34216 and follow the instructions to enter the license. -## Load TDengine Time-Series Data +## Data Analysis -This chapter demonstrates how to use the Seeq software to load TDengine time-series data. +### Scenario Introduction + +The example scenario is a power system where users collect electricity usage data from power station instruments daily and store it in the TDengine cluster. Now, users want to predict how power consumption will develop and purchase more equipment to support it. User power consumption varies with monthly orders, and considering seasonal changes, power consumption will differ. This city is located in the northern hemisphere, so more electricity is used in summer. We simulate data to reflect these assumptions. + +### Data preparation **Step 1**, Create tables in TDengine. @@ -246,12 +248,6 @@ The source code is hosted on [GitHub Repository](https://github.com/sangshuduo/t } ``` -## Data Analysis - -### Scenario Introduction - -The example scenario is a power system where users collect electricity usage data from power station instruments daily and store it in the TDengine cluster. Now, users want to predict how power consumption will develop and purchase more equipment to support it. User power consumption varies with monthly orders, and considering seasonal changes, power consumption will differ. This city is located in the northern hemisphere, so more electricity is used in summer. We simulate data to reflect these assumptions. - ### Using Seeq Workbench Log in to the Seeq service page and create a new Seeq Workbench. By selecting data sources from search results and choosing different tools as needed, you can display data or make predictions. For detailed usage methods, refer to the [official knowledge base](https://support.seeq.com/space/KB/146440193/Seeq+Workbench). 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 2ac8690c41..d8dc200fd6 100644 --- a/docs/en/10-third-party/05-bi/11-superset.md +++ b/docs/en/10-third-party/05-bi/11-superset.md @@ -12,31 +12,34 @@ Through the Python connector of TDengine, Superset can support TDengine data sou ## Prerequisites Prepare the following environment: -- TDengine is installed and running normally (both Enterprise and Community versions are available) -- taosAdapter is running normally, refer to [taosAdapter](../../../tdengine-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 +- TDengine 3.2.3.0 and above version is installed and running normally (both Enterprise and Community versions are available). +- taosAdapter is running normally, refer to [taosAdapter](../../../tdengine-reference/components/taosadapter/). +- Apache Superset version 2.1.0 or above is already installed, refre to [Apache Superset](https://superset.apache.org/). +- Install Python connector driver, refer to [Python Client Library](../../../tdengine-reference/client-libraries/python). +:::tip 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. -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 -pip3 install taospy -pip3 install taos-ws-py -``` +::: -## Configure TDengine Connection In Superset +## Configure Data Source + +**Step 1**, enter the new database connection page, [Superset] -> [Setting] -> [Database Connections] -> [+DATABASE]. + +**Step 2**, select TDengine database connection, select the `TDengine` option from the drop-down list of [SUPPORTED DATABASES]. -**Step 1**, enter the new database connection page, "Superset" → "Setting" → "Database Connections" → "+DATABASE" -**Step 2**, select TDengine database connection, select the "TDengine" option from the drop-down list of "SUPPORTED DATABASES". :::tip If there is no TDengine option in the drop-down list, please confirm that the steps of installing, `Superset` is first and `Python Connector` is second. ::: -**Step 3**, write a name of connection in "DISPLAY NAME" -**Step 4**, The "SQLALCHEMY URL" field is a key connection information string, and it must be filled in correctly + +**Step 3**, write a name of connection in [DISPLAY NAME]. + +**Step 4**, The [SQLALCHEMY URL] field is a key connection information string, and it must be filled in correctly. + ```bash taosws://user:password@host:port ``` + | Parameter |
Parameter Description
| |:---------- |:--------------------------------------------------------- | |user | Username for logging into TDengine database | @@ -44,32 +47,34 @@ taosws://user:password@host:port |host | Name of the host where the TDengine database is located | |port | The port that provides WebSocket services, default is 6041 | -Example: -The TDengine database installed on this machine provides WebSocket service port 6041, using the default username and password, "SQLALCHEMY URL" is: +Example: + +The TDengine database installed on this machine provides WebSocket service port 6041, using the default username and password, `SQLALCHEMY URL` is: + ```bash taosws://root:taosdata@localhost:6041 ``` -**Step 5**, configure the connection string, click "TEST CONNECTION" to test if the connection can be successful. After passing the test, click the "CONNECT" button to complete the connection + +**Step 5**, configure the connection string, click "TEST CONNECTION" to test if the connection can be successful. After passing the test, click the "CONNECT" button to complete the connection. +## Data Analysis -## Start +### Data preparation -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 -2. Select the "TDengine" data source that has been created earlier from the dropdown list of "DATABASES" 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) -4. "SEE TABLE SCHEMA" select the name of the super table or regular table to be operated on (sub tables are not displayed) -5. Subsequently, the schema information of the selected table will be displayed in the following area -6. In the SQL editor area, any SQL statement that conforms to TDengine syntax can be entered for execution +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: -## Example +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 of [DATABASES] 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). +4. [SEE TABLE SCHEMA] select the name of the super table or regular table to be operated on (sub tables are not displayed). +5. Subsequently, the schema information of the selected table will be displayed in the following area. +6. In the `SQL` editor area, any `SQL` statement that conforms to `TDengine` syntax can be entered for execution. -We chose two popular templates from the Superset Chart template to showcase their effects, using smart meter data as an example: +### Smart Meter Example -1. "Aggregate" Type, which displays the maximum voltage value collected per minute during the specified time period in Group 4 +We chose two popular templates from the [Superset Chart] template to showcase their effects, using smart meter data as an example: - ![superset-demo1](./superset-demo1.jpeg) - -2. "RAW RECORDS" Type, which displays the collected values of current and voltage during the specified time period in Group 4 - - ![superset-demo2](./superset-demo2.jpeg) \ No newline at end of file +1. `Aggregate` Type, which displays the maximum voltage value collected per minute during the specified time period in Group 4. +![superset-demo1](./superset-demo1.jpeg) +2. `RAW RECORDS` Type, which displays the collected values of current and voltage during the specified time period in Group 4. +![superset-demo2](./superset-demo2.jpeg) \ No newline at end of file diff --git a/docs/zh/10-third-party/05-bi/05-yhbi.md b/docs/zh/10-third-party/05-bi/05-yhbi.md index b0a25eac83..caba25e891 100644 --- a/docs/zh/10-third-party/05-bi/05-yhbi.md +++ b/docs/zh/10-third-party/05-bi/05-yhbi.md @@ -16,7 +16,7 @@ toc_max_heading_level: 4 - TDengine 3.3.2.0 以上版本集群已部署并正常运行（企业及社区版均可）。 - taosAdapter 能够正常运行，详细参考 [taosAdapter 参考手册](../../../reference/components/taosadapter)。 - 确保永洪 BI 已经安装并运行（如果未安装，请到永洪科技官方下载页面下载）。 -- 安装JDBC驱动。从 maven.org 下载 TDengine JDBC 连接器文件 `taos-jdbcdriver-3.4.0-dist.jar` 及以上版本。 +- 安装 JDBC 驱动。从 maven.org 下载 TDengine JDBC 连接器文件 `taos-jdbcdriver-3.4.0-dist.jar` 及以上版本。 ## 配置数据源 diff --git a/docs/zh/10-third-party/05-bi/09-seeq.md b/docs/zh/10-third-party/05-bi/09-seeq.md index 24d3457f87..677dd39635 100644 --- a/docs/zh/10-third-party/05-bi/09-seeq.md +++ b/docs/zh/10-third-party/05-bi/09-seeq.md @@ -18,8 +18,6 @@ Seeq 是制造业和工业互联网（IIOT）高级分析软件。Seeq 支持在 ## 配置数据源 -### 配置 JDBC 连接器 - **第 1 步**，查看 data 存储位置 ``` @@ -38,9 +36,13 @@ sudo seeq restart 使用浏览器访问 ip:34216 并按照说明输入 license。 -### 加载 TDengine 时序数据 +## 数据分析 -本章节演示如何使用 Seeq 软件加载 TDengine 时序数据。 +### 场景介绍 + +示例场景为一个电力系统，用户每天从电站仪表收集用电量数据，并将其存储在 TDengine 集群中。现在用户想要预测电力消耗将会如何发展，并购买更多设备来支持它。用户电力消耗随着每月订单变化而不同，另外考虑到季节变化，电力消耗量会有所不同。这个城市位于北半球，所以在夏天会使用更多的电力。我们模拟数据来反映这些假定。 + +### 数据准备 **第 1 步**，在 TDengine 中创建表。 @@ -240,12 +242,6 @@ taos -s "insert into power.goods select _wstart, _wstart + 10d, avg(goods) from } ``` -## 数据分析 - -### 场景介绍 - -示例场景为一个电力系统，用户每天从电站仪表收集用电量数据，并将其存储在 TDengine 集群中。现在用户想要预测电力消耗将会如何发展，并购买更多设备来支持它。用户电力消耗随着每月订单变化而不同，另外考虑到季节变化，电力消耗量会有所不同。这个城市位于北半球，所以在夏天会使用更多的电力。我们模拟数据来反映这些假定。 - ### 使用 Seeq Workbench 登录 Seeq 服务页面并新建 Seeq Workbench，通过选择数据源搜索结果和根据需要选择不同的工具，可以进行数据展现或预测，详细使用方法参见 [官方知识库](https://support.seeq.com/space/KB/146440193/Seeq+Workbench)。 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 337fc53825..a2f3847d29 100644 --- a/docs/zh/10-third-party/05-bi/11-superset.md +++ b/docs/zh/10-third-party/05-bi/11-superset.md @@ -4,38 +4,39 @@ title: 与 Superset 集成 --- ‌Apache Superset‌ 是一个现代的企业级商业智能（BI）Web 应用程序，主要用于数据探索和可视化。它由 Apache 软件基金会支持，是一个开源项目，它拥有活跃的社区和丰富的生态系统。Apache Superset 提供了直观的用户界面，使得创建、分享和可视化数据变得简单，同时支持多种数据源和丰富的可视化选项‌。 -通过 TDengine 的 Python 连接器, ‌Apache ‌Superset‌ 可支持 TDengine 数据源并提供数据展现、分析等功能 +通过 TDengine 的 Python 连接器, ‌Apache ‌Superset‌ 可支持 TDengine 数据源并提供数据展现、分析等功能。 ## 前置条件 准备以下环境： -- TDengine 集群已部署并正常运行（企业及社区版均可） -- taosAdapter 能够正常运行。详细参考 [taosAdapter 使用手册](../../../reference/components/taosadapter) -- Apache Superset v2.1.0 或以上版本已安装。安装 Apache Superset 请参考 [官方文档](https://superset.apache.org/) +- TDengine 3.2.3.0 及以上版本集群已部署并正常运行（企业及社区版均可）。 +- taosAdapter 能够正常运行，详细参考 [taosAdapter 使用手册](../../../reference/components/taosadapter)。 +- Apache Superset v2.1.0 或以上版本已安装，安装 Apache Superset 请参考 [官方文档](https://superset.apache.org/)。 +- 安装 Python 连接器驱动，详细参考 [TDengine Python Connector](../../../reference/connector/python)。 - -## 安装 TDengine Python 连接器 - -TDengine Python 连接器从 `v2.1.18` 起带 Superset 连接驱动，会安装至 Superset 相应目录下并向 Superset 提供数据源服务 -Superset 与 TDengine 之间使用 WebSocket 协议连接，需安装支持此协议的 `taos-ws-py` 组件, 全部安装脚本如下： -```bash -pip3 install taospy -pip3 install taos-ws-py -``` - -## 配置 TDengine 数据源 - -**第 1 步**，进入新建数据库连接页面 "Superset" → "Setting" → "Database Connections" → "+DATABASE" -**第 2 步**，选择 TDengine 数据库连接。"SUPPORTED DATABASES" 下拉列表中选择 "TDengine" 项。 :::tip -注意：若下拉列表中无 "TDengine" 项，请检查安装顺序，确保 `TDengine Python 连接器` 在 `Superset` 安装之后再安装。 +TDengine Python 连接器从 `v2.1.18` 起带 Superset 连接驱动，会安装至 Superset 相应目录下并向 Superset 提供数据源服务。 +::: + +## 配置数据源 + +**第 1 步**，进入新建数据库连接页面【Superset】 -> 【Setting】->【Database Connections ->【+DATABASE】。 + +**第 2 步**，选择 TDengine 数据库连接。【SUPPORTED DATABASES】下拉列表中选择 `TDengine` 项。 + +:::tip +注意：若下拉列表中无 `TDengine` 项，请检查安装顺序，确保 `TDengine Python 连接器` 在 `Superset` 安装之后再安装。 ::: -**第 3 步**，"DISPLAY NAME" 中填写连接名称，任意填写即可。 -**第 4 步**，"SQLALCHEMY URL" 项为关键连接信息串，务必填写正确。 + +**第 3 步**，【DISPLAY NAME】中填写连接名称，任意填写即可。 + +**第 4 步**，【SQLALCHEMY URL】项为关键连接信息串，务必填写正确。 + ```bash taosws://用户名:密码@主机名:端口号 ``` + | 参数名称 |
参数说明
| |:------- |:-------------------------------- | | 用户名 | 登录 TDengine 数据库用户名 | @@ -43,32 +44,33 @@ taosws://用户名:密码@主机名:端口号 | 主机名 | TDengine 数据库所在主机名称 | | 端口号 | 提供 WebSocket 服务的端口，默认：6041 | -示例： -本机安装 TDengine 数据库，WebSocket 服务端口 6041，使用默认用户名密码，"SQLALCHEMY URL" 应为： +示例： + +本机安装 TDengine 数据库，WebSocket 服务端口 6041，使用默认用户名密码，`SQLALCHEMY URL` 应为： + ```bash taosws://root:taosdata@localhost:6041 ``` -**第 5 步**，配置好连接串，点击 “TEST CONNECTION” 测试连接是否成功，测试通过后点击 “CONNECT” 按钮，完成连接。 +**第 5 步**，配置好连接串，点击【TEST CONNECTION】测试连接是否成功，测试通过后点击【CONNECT】按钮，完成连接。 +## 数据分析 -## 开始使用 +### 数据准备 -TDengine 数据源与其它数据源使用上无差别，这里简单介绍下数据查询： -1. Superset 界面点击右上角 “+” 号按钮，选择 “SQL query”, 进入查询界面 -2. 左上角 “DATABASE” 下拉列表中选择前面已创建好的 “TDengine” 数据源 -3. “SCHEMA” 下拉列表，选择要操作的数据库名（系统库不显示） -4. “SEE TABLE SCHEMA” 选择要操作的超级表名或普通表名（子表不显示） -5. 随后会在下方显示选定表的 SCHEMA 信息 -6. 在 SQL 编辑器区域可输入符合 TDengine 语法的任意 SQL 语句执行 +TDengine 数据源与其它数据源使用上无差别，这里简单介绍下数据查询： -## 示例效果 +1. `Superset` 界面点击右上角【+】号按钮，选择 `SQL query`, 进入查询界面。 +2. 左上角【DATABASE】下拉列表中选择前面已创建好的 `TDengine` 数据源。 +3. 【SCHEMA】下拉列表，选择要操作的数据库名（系统库不显示）。 +4. 【SEE TABLE SCHEMA】选择要操作的超级表名或普通表名（子表不显示）。 +5. 随后会在下方显示选定表的 `SCHEMA` 信息。 +6. 在 `SQL` 编辑器区域可输入符合 `TDengine` 语法的任意 `SQL` 语句执行。 -我们选择 Superset Chart 模板中较流行的两个模板做了效果展示，以智能电表数据为例： +### 智能电表样例 -1. "Aggregate" 类型，展示在第 4 组中指定时间段内每分钟采集电压值(voltage)最大值 +我们选择【Superset Chart】模板中较流行的两个模板做了效果展示，以智能电表数据为例： - ![superset-demo1](./superset-demo1.jpeg) - -2. "RAW RECORDS" 类型，展示在第 4 组中指定时间段内 current, voltage 的采集值 - - ![superset-demo2](./superset-demo2.jpeg) +1. `Aggregate` 类型，展示在第 4 组中指定时间段内每分钟采集电压值(voltage)最大值。 +![superset-demo1](./superset-demo1.jpeg) +2. `RAW RECORDS` 类型，展示在第 4 组中指定时间段内 current, voltage 的采集值。 +![superset-demo2](./superset-demo2.jpeg) diff --git a/docs/zh/10-third-party/05-bi/12-tableau.md b/docs/zh/10-third-party/05-bi/12-tableau.md index 0478b3f7d5..9fbdc53d45 100644 --- a/docs/zh/10-third-party/05-bi/12-tableau.md +++ b/docs/zh/10-third-party/05-bi/12-tableau.md @@ -11,7 +11,7 @@ Tableau 是一款知名的商业智能工具，它支持多种数据源，可方 - TDengine 3.3.5.4 以上版本集群已部署并正常运行（企业及社区版均可） - taosAdapter 能够正常运行。详细参考 [taosAdapter 参考手册](../../../reference/components/taosadapter) - Tableau 桌面版安装并运行（如未安装，请下载并安装 Windows 操作系统 64 位 [Tableau 桌面版](https://www.tableau.com/products/desktop/download) ）。安装 Tableau 桌面版请参考 [官方文档](https://www.tableau.com)。 -- 从TDengine官网下载最新的Windows操作系统X64客户端驱动程序，并进行安装。详细参考 [安装 ODBC 驱动](../../../reference/connector/odbc/#安装)。 +- 从 TDengine 官网下载最新的 Windows 操作系统 X64 客户端驱动程序，并进行安装。详细参考 [安装 ODBC 驱动](../../../reference/connector/odbc/#安装)。 ## 配置数据源