IoTDB-Workbench 技术文档

1. 安装指南

1.1 环境准备

在开始安装之前，请确保您的系统满足以下要求：

• Java 8 或更高版本
• Node.js 12 或更高版本
• Maven 3.6 或更高版本

1.2 下载项目

您可以通过以下命令从GitHub下载IoTDB-Workbench项目：

git clone https://github.com/apache/iotdb-web-workbench.git
cd iotdb-web-workbench

1.3 安装依赖

进入项目目录后，分别安装前端和后端的依赖：

# 安装后端依赖
cd backend
mvn clean install

# 安装前端依赖
cd ../frontend
npm install

2. 项目的使用说明

2.1 后端服务运行

在backend目录下，运行以下命令启动后端服务：

mvn spring-boot:run

后端服务默认运行在http://localhost:8080。

2.2 前端服务运行

在frontend目录下，运行以下命令启动前端服务：

npm run serve

前端服务默认运行在http://localhost:8081。

2.3 Casdoor单点登录运行

Casdoor是一个单点登录解决方案，用于IoTDB-Workbench的身份验证。请参考Casdoor运行说明进行配置和启动。

3. 项目API使用文档

3.1 数据查询API

• URL: /api/query
• Method: POST
• Request Body:

  {
    "sql": "SELECT * FROM root.sg.d1 WHERE time >= 1609459200000 AND time < 1609462800000"
  }
  

• Response:

  {
    "status": "success",
    "data": [
      {
        "time": 1609459200000,
        "value": 123.45
      },
      {
        "time": 1609459260000,
        "value": 124.56
      }
    ]
  }
  

3.2 数据插入API

• URL: /api/insert
• Method: POST
• Request Body:

  {
    "sql": "INSERT INTO root.sg.d1(time, s1) VALUES(1609459200000, 123.45)"
  }
  

• Response:

  {
    "status": "success"
  }
  

4. 项目安装方式

4.1 源码安装

如前所述，通过Git克隆项目并安装依赖后，分别启动前端和后端服务即可。

4.2 Docker安装

IoTDB-Workbench也支持通过Docker进行安装。您可以使用以下命令构建并运行Docker容器：

docker-compose up -d

Docker容器启动后，前端服务将运行在http://localhost:8081，后端服务运行在http://localhost:8080。

---

通过以上步骤，您可以顺利安装并使用IoTDB-Workbench进行数据管理。如有任何问题，请参考项目文档或联系开发团队。