# TDengine-Explorer-Open-Source

**Repository Path**: blue__sky/Open-TDengine-Explorer

## Basic Information

- **Project Name**: TDengine-Explorer-Open-Source
- **Description**: TDengine Explorer 开源版 | 轻量级 TDengine Web 管理工具 | 基本功能可以平替商业版 TDengine Explorer | 支持 TDengine 3.x | 时序数据库可视化 | SQL控制台 | 零代码写入 | SPC分析 | Node-RED | MQTT接入
- **Primary Language**: NodeJS
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2026-06-02
- **Last Updated**: 2026-06-02

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# TDengine Explorer 开源版（平替商业版 TDengine Explorer）

<div align="center">
  <strong>轻量级 TDengine 一体化管理 Web 应用</strong>
  <p>基于 Vue 3 + Vite + TypeScript 构建，替代商业版 TDengine Explorer，开箱即用</p>
</div>

[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
[![技术栈](https://img.shields.io/badge/技术栈-Vue3%20+%20Vite%20+%20TypeScript-brightgreen.svg)](https://vuejs.org/)
[![适配TDengine](https://img.shields.io/badge/适配-TDengine%202.x%2F3.x-orange.svg)](https://www.taosdata.com/)

---

## 📚 项目简介

Open TDengine Explorer 是一款**自研轻量级** TDengine 时序数据库一体化管理 Web 应用，区别于商业版 TDengine Explorer，无需复杂部署，支持连接管理、库表浏览、SQL 控制台、零代码数据写入、SPC 过程能力分析、Node-RED 工作流集成与数据订阅等核心功能，系统功能完整可用，适配 TDengine 2.x/3.x 全版本。

## ✨ 核心功能

- 🔐 **登录与连接管理**：用户名密码登录（首次登录自动设为管理员）；连接配置持久化、测试、增删改查
- 📊 **数据库基础操作**：库表树状展示（子表标签筛选）、SQL 控制台、数据浏览、库/用户管理（需 root）
- 📥 **零代码数据写入**：MySQL/MQTT/OPC UA 多源接入；全量/增量同步、MQTT 解析、OPC UA 节点订阅/轮询
- 📈 **SPC 分析任务**：过程能力分析（CPK/CP/PPM/CA）；直方图/运行图/超限提醒、定时刷新、SQL/配置双模式
- 🔄 **Node-RED 集成**：每个连接专属实例，预装 TDengine 节点，代理访问不暴露端口
- 📢 **数据订阅管理**：查看订阅列表/消费者，复制 MQTT DSN/主题，订阅增删改查
- 🌐 **多语言/时区**：中英文切换、时区自适应，时间列精准展示
- 🛡️ **稳定性与运维**：配置写入前自动备份（保留 7 天）；顶栏配置服务健康状态指示；导入任务运行时长与写入条数统计；SQL 结果集仅展示前 2000 行（可导出 CSV 获取全部）；配置写入限流与关键操作日志

---

## 技术栈

- **前端**：Vue 3、Pinia、Vue Router、TypeScript；构建为 Vite；与 TDengine 通过 REST API 通信（taosAdapter 默认 6041，Basic 认证）。
- **后端（导入服务）**：Node.js + Express，提供 MySQL 拉取、MQTT 订阅写入、OPC UA 采集写入、Node-RED 实例管理与代理；端口与限流等配置见 `server/config/app.js`。

---

## 环境要求

- Node.js 18+
- 已安装并启动 TDengine，且已启动 **taosAdapter**（REST 端口默认 6041）

---

## 安装与运行

```bash
# 安装依赖
npm install

# 仅前端（连接、库表、SQL、数据订阅、基础信息可用；零代码写入与 Node-RED 需后端）
npm run dev
# 浏览器访问 http://localhost:5173

# 前端 + 后端一条命令（推荐）：先启动后端，待端口就绪后再启动前端
npm run dev:all
```

**后端单独启动**（与前端分终端时）：

```bash
# 终端一：导入服务，默认端口 9000
npm run server

# 终端二：前端，/api 由 Vite 代理到 http://localhost:9000
npm run dev
```

开发环境下前端通过 Vite 将 `/api` 及 Node-RED 相关 WebSocket 代理到后端（默认 `http://localhost:9000`），端口可在 `server/config/app.js` 中修改，并需与 `vite.config.ts` 中 `proxy['/api'].target` 一致。

**生产构建与运行**：

```bash
npm run build
# 设置 NODE_ENV=production 后运行 node server/index.js
# 若存在 dist 目录，后端会自动托管前端静态资源
```

更多生产部署与环境变量见根目录 **DEPLOY.md**；系统配置项见 **server/config/app.js**。运行 **`npm run test:run`** 可执行前端单元测试（Vitest）。

---

## 使用说明

1. **登录**：打开应用后输入用户名、密码登录；若服务端尚无用户，首次登录的账号将自动成为管理员。
2. **连接**：在首页新建或选择已有 TDengine 连接（主机、端口 6041、用户名、密码），测试通过后点击「连接」进入工作台。
3. **工作台**：左侧为数据库树与导航（数据库与操作、零代码写入、**SPC 分析任务**、Node-RED、数据订阅、基础信息）；右侧为多标签内容（SQL 控制台、数据浏览等）；顶部可切换时区与语言。
4. **SQL 与数据浏览**：在「数据库与操作」中选库后执行 SQL；点击左侧表或超级表可在「数据浏览」中查看数据（时间列按时区显示）。SQL 结果超过 2000 行时仅展示前 2000 行，可导出 CSV 获取全部。
5. **零代码写入**：在「零代码写入」中新建任务，选择数据源类型（MySQL / MQTT / OPC UA），按向导配置连接、解析（可选）、映射与目标库/目标表（下拉选择超级表）；可复制已有任务后编辑。启动后由导入服务持续运行，任务列表会显示已写入条数与运行时长，重启服务会自动恢复。
6. **SPC 分析任务**：在「SPC 分析任务」中新建任务，选择查询方式（配置输入或 SQL 输入）、数据库与超级表、时间列/数值列、规格上下限与目标值等；保存后可「查看图表」，获得直方图、运行图、过程能力统计与明细分页。
7. **Node-RED**：在「Node-RED」中打开当前连接专属的流程编辑器，使用预装的 TDengine 节点读写当前库表。
8. **数据订阅**：在「数据订阅」中查看与管理 TDengine 订阅，复制 MQTT DSN 与主题供外部消费。

应用内「帮助」入口可查看更详细的步骤说明与常见问题。

---

## 参考与致谢

- [TDengineGUI](https://github.com/skye0207/TDengineGUI) — 桌面管理与 SQL 控制台思路参考
- [balloonfish](https://gitee.com/xielaoshi99/balloonfish) — Vue3 + Vite 与 REST 方案参考
- [TDengine REST API 文档](https://docs.tdengine.com/tdengine-reference/client-libraries/rest-api/)

---

## 截图
![首页](docs/%E9%A6%96%E9%A1%B5.png)
![数据库连接列表](docs/%E6%95%B0%E6%8D%AE%E5%BA%93%E9%A1%B5.png)
![数据库操作](docs/%E6%95%B0%E6%8D%AE%E5%BA%93%E6%93%8D%E4%BD%9C.png)
![零代码接入](docs/%E5%BA%94%E7%94%A8%E7%95%8C%E9%9D%A2.png)
![零代码接入解析](docs/%E9%9B%B6%E4%BB%A3%E7%A0%81%E5%86%99%E5%85%A5.png)
![SPC分析](docs/SPC%E5%88%86%E6%9E%90%E4%BB%BB%E5%8A%A1.png)
![NodeRed接入](docs/NodeRed%E6%8E%A5%E5%85%A5.png)

---

## 许可证

MIT