# tdengine-workbench

**Repository Path**: bhdweb/tdengine-workbench

## Basic Information

- **Project Name**: tdengine-workbench
- **Description**: TD-Workbench是一个基于electron构建的，针对时序数据库TDengine的图形化管理工具。具有跨平台、易于使用、版本适应性强等特点
- **Primary Language**: JavaScript
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: https://gitee.com/bhdweb/tdengine-workbench
- **GVP Project**: No

## Statistics

- **Stars**: 50
- **Forks**: 14
- **Created**: 2021-07-01
- **Last Updated**: 2026-04-03

## Categories & Tags

**Categories**: Uncategorized

**Tags**: TDengine, TDengineGUI, TDengine客户端工具, tdengine-workbench, TD-Workbench

## README



# TD-Workbench

TD-Workbench 是一个基于 Electron 构建的针对时序数据库 TDengine 的图形化管理工具。具有跨平台、易于使用、版本适应性强等特点。全网唯一同时支持 **taos2.x与taos3.x** 的TDengine图形化管理工具。

![输入图片说明](static/icons/QQ_1774093187914.png)

## 功能特性

### 连接管理
- [x] 新增数据库连接
- [x] 删除数据库连接
- [x] 修改数据库连接
- [x] 支持多连接管理
- [x] 自动版本检测（兼容 TDengine 2.x 和 3.x）

### 数据库管理
- [x] 添加数据库
- [x] 删除数据库
- [x] 显示数据库属性
- [x] 修改部分数据库属性

### 超表管理
- [x] 显示数据库下所有超表（分页展示）
- [x] 根据表名查询超表
- [x] 创建超表
- [x] 修改超表字段和标签
- [x] 查询超表数据（默认降序，超过1000万行自动切换为升序）
- [x] 删除超表
- [x] 基于超表创建子表
- [x] 查看超表下的所有子表

### 普通表管理
- [x] 显示数据库下所有普通表（分页展示）
- [x] 根据表名查询普通表
- [x] 创建普通表
- [x] 修改普通表字段
- [x] 查询普通表数据
- [x] 删除普通表

### 自定义查询
- [x] 自由切换数据库
- [x] 执行编辑的 SQL 语句
- [x] 支持只执行选中的单条 SQL
- [x] 结果集分页显示
- [x] 错误信息显示

## 技术栈

- **前端框架**: Vue.js + Vuex
- **桌面框架**: Electron
- **构建工具**: Webpack
- **数据库接口**: RESTful API

## 项目结构

```
tdengine-workbench/
├── .electron-vue/          # Electron + Vue 构建配置
│   ├── build.js           # 生产构建脚本
│   ├── dev-runner.js      # 开发运行脚本
│   ├── webpack.main.config.js
│   └── webpack.renderer.config.js
├── config/                # 环境配置文件
├── src/
│   ├── main/              # Electron 主进程
│   │   ├── config/        # 主进程配置
│   │   ├── services/     # 主进程服务
│   │   └── index.js       # 入口文件
│   └── renderer/         # Vue 渲染进程
│       ├── api/           # API 客户端
│       ├── store/         # Vuex 状态管理
│       ├── utils/         # 工具函数
│       ├── views/         # 页面组件
│       └── styles/        # 样式文件
└── static/                # 静态资源
```

## 快速开始

### 环境要求

- Node.js >= 12.x
- npm >= 6.x 或 yarn

### 安装依赖

```bash
# 克隆项目
git clone https://gitee.com/bhdweb/tdengine-workbench

# 进入项目目录
cd tdengine-workbench

# 安装依赖
npm install
```

### 配置镜像（可选）

如果网络较慢，建议配置 npm 和 Electron 镜像：

```bash
# 设置 npm 镜像
npm config set registry https://registry.npm.taobao.org

# 设置 Electron 镜像
npm config set electron_mirror https://cdn.npm.taobao.org/dist/electron/
```

### 启动开发服务器

```bash
npm run dev
# 或
yarn dev
```

### 构建安装包

```bash
# 构建 Windows 64位安装包
npm run build:win64

# 构建完成后，安装包位于 build 目录下
```

## 使用说明

1. **新建连接**: 点击"新建连接"按钮，添加 TDengine 服务器
2. **连接配置**: 需要提供服务器 IP、RESTful 端口（默认 6041）、用户名和密码（默认 root:taosdata）
3. **数据管理**: 连接成功后，左侧会显示数据库列表，可进行超表和普通表的管理操作

## 版本兼容性

- 支持 TDengine 2.x
- 支持 TDengine 3.x
- 通过 RESTful 接口连接，基本不受服务器版本升级影响

## 许可证

MIT License