fix: doc add context
This commit is contained in:
Alex Duan
parent
8d3ea75268
commit
9a3fee1b95
|
|
@ -9,41 +9,46 @@ toc_max_heading_level: 4
|
|||
|
||||
## 版本要求
|
||||
SuperSet 版本： >= 2.1.0
|
||||
taospy 连接器版本 >= 2.1.6
|
||||
taos-ws-py 连接器版本 >= 2.0.1
|
||||
TDengine 版本： >= 3.0 及以上
|
||||
taospy 连接器版本 >= 2.1.17
|
||||
taos-ws-py 连接器版本 >= 0.3.0
|
||||
TDengine 版本： >= 3.1
|
||||
|
||||
## 安装驱动
|
||||
第 1 步，首先安装 Apache Superset 要求的版本。
|
||||
第 2 步，安装 TDengine 的 Python 连接器要求的版本。
|
||||
第 3 步，安装 TDengine 的 Python Websocket 连接器要求的版本。
|
||||
**注意** 第 1 步和第 2 步不能颠倒，否则会导致 TDengine 无法把驱动文件安装到 SuperSet 指定的目录下。
|
||||
## 安装 Apache Superset
|
||||
确保已安装 Apache SuperSet V2.1.0 及以上版本, 如未安装，请到其 [官网](https://superset.apache.org/) 安装
|
||||
|
||||
## SuperSet 中配置连接驱动
|
||||
## 安装 TDengine
|
||||
TDengine 企业版及社区版均可支持，要求版本在 3.0 及以上即可
|
||||
|
||||
这里我们在 SuperSet 中配置 TDengine 的驱动连接信息
|
||||
## 安装 TDengine Python 连接器
|
||||
TDengine 的 Python 连接器 V2.1.17 及之后版本中自带支持 SuperSet 的连接驱动，会自动安装到 SuperSet 的安装目录下，连接使用的是 Websocket 协议，所以还需要安装 taos-ws-py 组件, 安装脚本如下：
|
||||
```bash
|
||||
pip3 install taospy
|
||||
pip3 install taos-ws-py
|
||||
```
|
||||
|
||||
第 1 步 SuperSet 界面中右上角 Setting-> Database Connections 进入数据库连接管理页面。
|
||||
第 2 步 右上角按钮 +DATABASE 进入增加数据库连接页面。
|
||||
第 3 步 在 SUPPORTED DATABASES 的下拉列表中选择 “TDengine” 项。
|
||||
第 4 步 接下来的界面中 DISPLAY NAME 中给连接起个名字，随便填写即可。
|
||||
第 5 步 界面中 SQLALCHEMY URL* 项是关键连接信息串，需重点填写。
|
||||
连接串格式： 连接协议://用户名:密码@主机名:端口号
|
||||
## SuperSet 中配置连接
|
||||
进入
|
||||
|
||||
第1步，进入新建数据库连接页面
|
||||
SuperSet -> Setting-> Database Connections -> +DATABASE
|
||||
|
||||
第2步，选择 TDengine 数据库连接
|
||||
SUPPORTED DATABASES 下拉列表中选择 “TDengine” 项，若下拉列表中没有 TDengine 选项，请检查是否安装包安装顺序，需先安装 SuperSet 后安装 Python 连接器
|
||||
第3步，DISPLAY NAME 中给连接起个名字，随便填写即可
|
||||
第4步，SQLALCHEMY URL* 项为关键连接信息串，需重点填写。
|
||||
连接串格式： taosws://用户名:密码@主机名:端口号
|
||||
参数说明：
|
||||
连接协议：
|
||||
taos: native 连接方式
|
||||
taosws: websocket 连接方式
|
||||
taosrest: restful 连接方式
|
||||
用户名： 登录 TDengine 数据库的用户名
|
||||
密码： 登录 TDengine 数据库的密码
|
||||
主机名： TDengine 数据库所在主机的名称
|
||||
端口号： 根据不同协议提供登录的端口号
|
||||
taos 协议默认端口 6030
|
||||
taosws 协议默认端口 6041
|
||||
taosrest 协议默认端口 6041
|
||||
示例：以 websocket 协议连接本机的 TDengine 数据库，使用默认用户名密码
|
||||
taosws://root:taosdata@localhost:6041
|
||||
第 6 步 配置好以上关键信息后，可点击 "TEST CONNECTION" 测试连接是否能够成功，测试通过后点 CONNECT 按钮，完成连接
|
||||
| 参数名称 | 参数说明 |
|
||||
| ------- | ------ |
|
||||
| 用户名： | 登录 TDengine 数据库的用户名
|
||||
| 密码： | 登录 TDengine 数据库的密码
|
||||
| 主机名： | TDengine 数据库所在主机的名称
|
||||
| 端口号： | 提供 WebSocket 服务的端口，默认为：6041
|
||||
|
||||
|
||||
- 示例：本机安装的 TDengine 数据库，提供 WebSocket 服务端口为 6041，使用默认用户名密码，连接串为：
|
||||
taosws://root:taosdata@localhost:6041
|
||||
第5步，配置好以上关键信息后，可点击 "TEST CONNECTION" 测试连接是否能够成功，测试通过后点 CONNECT 按钮，完成连接
|
||||
|
||||
|
||||
## 开始使用
|
||||
|
|
@ -54,3 +59,5 @@ TDengine 版本： >= 3.0 及以上
|
|||
第4步，SEE TABLE SCHEMA 对应 TDengine 超级表名及普通表名，子表不在此显示
|
||||
第5步，切换上面选择项，在下面相应会显示选择的表的列名及列数据类型信息及标识有索引的字段
|
||||
第6步，在中间SQL编辑器中可以输入符合 TDengine 语法的任意 SQL 语句执行并显示结果
|
||||
|
||||
## 示例
|
||||
Loading…
Reference in New Issue