fdb2 1.0.0 → 1.0.2

package/README.md

@@ -1,260 +1,373 @@
 # 数据库管理工具
 
-基于 TypeORM + Vue3 + Bootstrap5 构建的现代化数据库管理工具，仿 Navicat Premium 功能设计。
+一款轻量级、跨平台的数据库管理工具，支持多种数据库类型，提供类似 Navicat Premium 的使用体验。
 
-## 功能特性
+## 快速开始
 
-### 🔗 连接管理
-- 支持多种数据库类型：MySQL、PostgreSQL、SQLite、SQL Server、Oracle
-- 可视化连接配置界面
-- 连接测试和状态监控
-- 连接信息本地JSON存储
+### 安装
 
-### 🏗️ 数据库结构
-- 数据库信息概览
-- 表结构详细查看
-- 列信息、索引、外键关系展示
-- 数据库大小和统计信息
+```bash
+# 全局安装（推荐）
+npm install -g fdb2
 
-### 📊 数据操作
-- 表数据查看和分页
-- 条件查询和排序
-- 数据插入、编辑、删除
-- 数据导出（JSON、CSV格式）
+# 或使用 yarn
+yarn global add fdb2
 
-### 💻 SQL查询
-- 代码编辑器风格SQL输入框
-- SQL语法格式化
-- 查询历史记录
-- 批量查询结果展示
+# 或使用 pnpm
+pnpm add -g fdb2
+```
 
-## 项目结构
+### 启动服务
 
-### 后端（MidwayJS + TypeORM）
-```
-src/
-├── model/                          # 数据模型定义
-│   ├── connection.entity.ts         # 连接配置实体
-│   └── database.entity.ts          # 数据库信息实体
-├── service/                        # 业务服务层
-│   ├── connection.service.ts        # 连接管理服务
-│   └── database.service.ts         # 数据库操作服务
-└── controller/                     # API控制器
-    └── database.controller.ts       # 数据库管理API
+```bash
+# 启动数据库管理工具
+fdb2 start
+
+# 停止服务
+fdb2 stop
+
+# 查看服务状态
+fdb2 status
+
+# 重启服务
+fdb2 restart
 ```
 
-### 前端（Vue3 + Bootstrap5）
+### 访问应用
+
+启动服务后，在浏览器中打开：
 ```
-web/src/platform/database/          # 数据库管理模块
-├── layout.vue                     # 主布局组件
-├── index.vue                      # 首页仪表板
-├── connections.vue                 # 连接管理页面
-├── schemas.vue                    # 数据库结构页面
-├── query.vue                      # SQL查询页面
-├── table.vue                      # 表数据查看页面
-└── router.ts                      # 路由配置
-
-web/src/
-├── service/database.ts             # 前端API服务
-├── typings/database.ts            # TypeScript类型定义
-└── assets/database.css            # 专用样式文件
+http://localhost:3000
 ```
 
-## 快速开始
+## 功能特性
 
-### 1. 启动后端服务
-```bash
-npm run dev:midway
-```
+### 🔗 连接管理
+- 支持 8 种数据库类型：MySQL、PostgreSQL、SQLite、SQL Server、Oracle、CockroachDB、MongoDB、SAP HANA
+- 可视化连接配置界面，操作简单直观
+- 一键测试连接，快速验证配置
+- 连接信息本地安全存储，无需重复输入
 
-### 2. 启动前端开发服务器
-```bash
-npm run dev:vue
-```
+### 🏗️ 数据库结构
+- 清晰的数据库信息概览
+- 详细的表结构查看
+- 完整的列信息、索引、外键关系展示
+- 实时显示数据库大小和统计信息
 
-### 3. 访问应用
-打开浏览器访问：`http://localhost:3000/database`
+### 📊 数据操作
+- 表数据快速查看和分页浏览
+- 灵活的条件查询和排序
+- 便捷的数据插入、编辑、删除
+- 支持导出数据为 JSON、CSV 格式
+
+### 💻 SQL查询
+- 代码编辑器风格的 SQL 输入框
+- SQL 语法格式化，提升可读性
+- 自动保存查询历史记录
+- 批量查询结果展示
+
+### 🎯 核心优势
+- **零配置启动**：全局安装后即可使用，无需复杂配置
+- **跨平台支持**：Windows、macOS、Linux 全平台兼容
+- **轻量高效**：基于 Node.js，资源占用低
+- **本地存储**：数据保存在本地，安全可靠
+- **离线使用**：无需联网即可管理本地数据库
 
 ## 使用指南
 
 ### 添加数据库连接
 
-1. 进入"连接管理"页面
-2. 点击"新增连接"按钮
-3. 填写连接信息：
-   - 连接名称：自定义名称，便于识别
-   - 数据库类型：选择对应的数据库类型
-   - 主机地址：数据库服务器地址
-   - 端口：数据库服务端口（会自动填充默认端口）
-   - 数据库名称：要连接的数据库名
-   - 用户名/密码：数据库认证信息
-4. 点击"测试连接"验证配置
-5. 保存连接配置
+1. 打开浏览器访问 `http://localhost:3000`
+2. 点击左侧导航的"连接管理"
+3. 点击"新增连接"按钮
+4. 填写连接信息：
+   - **连接名称**：自定义名称，便于识别（如：生产环境 MySQL）
+   - **数据库类型**：选择对应的数据库类型
+   - **主机地址**：数据库服务器地址（本地数据库使用 `localhost` 或 `127.0.0.1`）
+   - **端口**：数据库服务端口（会自动填充默认端口）
+   - **数据库名称**：要连接的数据库名
+   - **用户名/密码**：数据库认证信息
+5. 点击"测试连接"验证配置是否正确
+6. 保存连接配置
 
 ### 查看数据库结构
 
-1. 进入"数据库结构"页面
+1. 在左侧导航选择"数据库结构"
 2. 选择已配置的数据库连接
 3. 选择要查看的数据库
 4. 浏览表列表和详细信息：
-   - 表基本信息（行数、大小等）
-   - 列定义（数据类型、约束等）
-   - 索引信息
-   - 外键关系
+   - **表基本信息**：行数、大小等统计信息
+   - **列定义**：数据类型、约束、默认值等
+   - **索引信息**：主键、唯一索引、普通索引
+   - **外键关系**：表之间的关联关系
 
-### 数据操作
+### 查看和编辑表数据
 
 1. 在表列表中点击"数据"按钮
 2. 设置查询条件：
-   - WHERE条件：过滤数据
-   - 排序字段：指定排序方式
-   - 每页显示：调整分页大小
-3. 执行查询查看数据
+   - **WHERE 条件**：输入过滤条件（如：`id > 100`）
+   - **排序字段**：指定排序方式（如：`create_time DESC`）
+   - **每页显示**：调整分页大小（10/50/100/500）
+3. 点击"查询"按钮执行查询
 4. 支持的操作：
-   - 查看数据详情
-   - 编辑记录
-   - 删除记录
-   - 插入新数据
-   - 导出数据
+   - **查看详情**：点击行查看完整数据
+   - **编辑记录**：修改数据后保存
+   - **删除记录**：删除不需要的数据
+   - **插入新数据**：点击"新增"按钮添加数据
+   - **导出数据**：选择 JSON 或 CSV 格式导出
 
-### SQL查询
+### 执行 SQL 查询
 
-1. 进入"SQL查询"页面
+1. 点击左侧导航的"SQL 查询"
 2. 选择数据库连接
-3. 在编辑器中输入SQL语句
-4. 功能特性：
-   - Ctrl/Cmd + Enter 快速执行
-   - SQL格式化美化
-   - 查询历史记录
-   - 结果导出功能
-
-## 数据存储
-
-### 连接配置存储
-- 位置：`data/connections.json`
-- 格式：JSON数组
-- 安全：密码明文存储（生产环境建议加密）
-
-### 查询历史存储
-- 位置：浏览器LocalStorage
-- 键名：`db-query-history`
-- 数量限制：最多保存50条记录
-
-## API接口
-
-### 连接管理
-- `GET /api/database/connections` - 获取所有连接
-- `POST /api/database/connections` - 添加连接
-- `PUT /api/database/connections/:id` - 更新连接
-- `DELETE /api/database/connections/:id` - 删除连接
-- `POST /api/database/connections/test` - 测试连接
-
-### 数据库操作
-- `GET /api/database/connections/:id/databases` - 获取数据库列表
-- `GET /api/database/connections/:id/databases/:name` - 获取数据库信息
-- `GET /api/database/connections/:id/databases/:name/tables` - 获取表列表
-- `GET /api/database/connections/:id/databases/:name/tables/:table` - 获取表信息
-- `GET /api/database/connections/:id/databases/:name/tables/:table/data` - 获取表数据
-- `POST /api/database/connections/:id/query` - 执行SQL查询
-- `GET /api/database/connections/:id/databases/:name/tables/:table/export` - 导出数据
-
-## 技术栈
-
-### 后端
-- **框架**: MidwayJS
-- **ORM**: TypeORM
-- **数据库**: 支持多种数据库类型
-- **语言**: TypeScript
-
-### 前端
-- **框架**: Vue 3
-- **路由**: Vue Router 4
-- **状态管理**: Pinia
-- **UI框架**: Bootstrap 5
-- **图标**: Bootstrap Icons
-- **HTTP客户端**: Axios
-- **语言**: TypeScript
-
-## 开发注意事项
-
-### 后端开发
-- 服务类继承自`BaseService`
-- 使用`@Inject`和`@Provide`装饰器
-- 统一的错误处理机制
-- 数据库连接池管理
-
-### 前端开发
-- 组件化设计，保持代码解耦
-- 使用TypeScript类型检查
-- 响应式设计，支持移动端
-- 统一的样式规范
-
-### 安全考虑
-- SQL注入防护（使用参数化查询）
-- 连接信息安全存储
-- 权限验证（需要登录）
-- 敏感信息脱敏显示
-
-## 扩展功能
-
-### 计划中的功能
-- [ ] 数据库备份和恢复
-- [ ] 数据同步功能
-- [ ] 可视化查询构建器
-- [ ] 数据导入功能
-- [ ] 用户权限管理
-- [ ] 操作日志记录
-- [ ] 性能监控
-- [ ] 查询优化建议
-
-### 自定义扩展
-- 可以通过添加新的数据库驱动支持更多数据库类型
-- 可以扩展前端组件添加更多数据可视化功能
-- 可以集成定时任务实现数据备份自动化
-
-## 故障排除
-
-### 常见问题
-
-1. **连接失败**
-   - 检查数据库服务是否运行
-   - 验证网络连接和端口
-   - 确认用户名密码正确
-
-2. **查询超时**
-   - 检查SQL语句是否正确
-   - 考虑添加索引优化查询
-   - 调整查询超时设置
-
-3. **数据显示异常**
-   - 确认数据编码设置
-   - 检查字段类型映射
-   - 验证数据完整性
-
-### 日志查看
-- 后端日志：`logs/`目录下
-- 前端控制台：浏览器开发者工具
-- 网络请求：浏览器Network面板
-
-## 贡献指南
-
-1. Fork项目
-2. 创建功能分支
-3. 提交代码变更
-4. 推送到分支
-5. 创建Pull Request
-
-## 许可证
-
-MIT License
-
-## 联系方式
-
-如有问题或建议，请通过以下方式联系：
-- 创建Issue
-- 发送邮件
-- 提交反馈
+3. 在编辑器中输入 SQL 语句
+4. 快捷操作：
+   - **Ctrl + Enter**（Windows）或 **Cmd + Enter**（Mac）：快速执行
+   - 点击"格式化"按钮：美化 SQL 语句
+   - 查看历史记录：点击历史记录按钮选择之前的查询
+5. 查看查询结果，支持导出功能
+
+### 常用 SQL 示例
+
+```sql
+-- 查询表前 10 条数据
+SELECT * FROM table_name LIMIT 10;
+
+-- 按条件查询
+SELECT * FROM users WHERE status = 'active' ORDER BY created_at DESC;
+
+-- 统计数据
+SELECT COUNT(*) as total, status FROM users GROUP BY status;
+
+-- 插入数据
+INSERT INTO users (name, email, status) VALUES ('张三', 'zhangsan@example.com', 'active');
+
+-- 更新数据
+UPDATE users SET status = 'inactive' WHERE last_login < '2024-01-01';
+
+-- 删除数据
+DELETE FROM logs WHERE created_at < '2024-01-01';
+```
+
+## 数据存储位置
+
+### 连接配置
+- **默认位置**：`~/.db-tool/connections.json`
+  - Windows: `C:\Users\用户名\.db-tool\connections.json`
+  - macOS/Linux: `/Users/用户名/.db-tool/connections.json` 或 `/home/用户名/.db-tool/connections.json`
+- **自定义位置**：设置环境变量 `DB_TOOL_DATA_DIR`
+  ```bash
+  # Windows
+  set DB_TOOL_DATA_DIR=D:\mydata\dbtool
+  
+  # macOS/Linux
+  export DB_TOOL_DATA_DIR=/path/to/custom/data
+  ```
+
+### 查询历史
+- **存储位置**：浏览器 LocalStorage
+- **自动保存**：每次执行查询后自动保存
+- **数量限制**：最多保存 50 条记录
+
+## 支持的数据库类型
+
+| 数据库类型 | 默认端口 | 特性 |
+|-----------|---------|------|
+| MySQL | 3306 | 支持存储过程、触发器、视图、全文搜索 |
+| PostgreSQL | 5432 | 支持存储过程、触发器、视图、JSON 类型 |
+| SQLite | - | 轻量级，文件型数据库，无需服务器 |
+| SQL Server | 1433 | 微软数据库，支持存储过程、触发器、视图 |
+| Oracle | 1521 | 企业级数据库，功能强大 |
+| CockroachDB | 26257 | 分布式 SQL 数据库，兼容 PostgreSQL |
+| MongoDB | 27017 | NoSQL 文档数据库 |
+| SAP HANA | 39013 | 内存数据库，高性能分析 |
+
+**兼容性说明**：
+- MariaDB、TiDB 兼容 MySQL，选择 MySQL 类型即可
+- Aurora MySQL 兼容 MySQL，选择 MySQL 类型即可
+- Aurora PostgreSQL 兼容 PostgreSQL，选择 PostgreSQL 类型即可
+- Better-SQLite3 兼容 SQLite，选择 SQLite 类型即可
+
+## 常见问题
+
+### 安装和启动
+
+**Q: 安装后无法启动服务？**
+
+A: 请检查以下几点：
+1. 确认已正确安装：`npm install -g fdb2`
+2. 检查 Node.js 版本（建议 v14 或更高）：`node --version`
+3. 查看错误信息：`fdb2 start --verbose`
+4. 检查端口 3000 是否被占用：`netstat -ano | findstr :3000`（Windows）或 `lsof -i :3000`（Mac/Linux）
+
+**Q: 如何更换端口？**
+
+A: 可以通过环境变量设置端口：
+```bash
+# Windows
+set PORT=8080
+fdb2 start
+
+# Mac/Linux
+PORT=8080 fdb2 start
+```
+
+### 连接问题
+
+**Q: 连接数据库失败怎么办？**
+
+A: 请按以下步骤排查：
+1. 确认数据库服务正在运行
+2. 检查网络连接和端口是否正确
+3. 验证用户名和密码是否正确
+4. 检查数据库是否允许远程连接
+5. 查看数据库防火墙设置
+
+**Q: SQLite 数据库连接失败？**
+
+A: SQLite 连接需要提供数据库文件路径：
+- 绝对路径：`D:\data\mydb.sqlite`
+- 相对路径：`./data/mydb.sqlite`（相对于数据目录）
+- 确保文件存在且有读取权限
+
+### 数据操作
+
+**Q: 查询结果为空？**
+
+A: 可能的原因：
+1. 表中确实没有数据
+2. WHERE 条件过于严格
+3. 数据库名称或表名错误
+4. 查询权限不足
+
+**Q: 无法编辑或删除数据？**
+
+A: 请检查：
+1. 是否有足够的数据库权限
+2. 表是否有外键约束
+3. 数据是否被锁定
+4. 查看数据库错误日志
+
+### 性能问题
+
+**Q: 查询速度很慢？**
+
+A: 优化建议：
+1. 添加适当的索引
+2. 限制查询结果数量（使用 LIMIT）
+3. 避免使用 `SELECT *`，只查询需要的字段
+4. 优化 WHERE 条件
+5. 考虑分批处理大数据量
+
+**Q: 数据库信息加载很慢？**
+
+A: 可能的原因：
+1. 数据库中表数量过多
+2. 表数据量过大
+3. 网络延迟
+4. 数据库性能问题
+
+### 数据安全
+
+**Q: 连接密码安全吗？**
+
+A: 当前版本密码以明文形式存储在本地配置文件中。建议：
+1. 不要在公共电脑上保存敏感数据库连接
+2. 定期更换数据库密码
+3. 使用只读权限的账号进行日常操作
+4. 生产环境建议使用加密连接（SSL/TLS）
+
+**Q: 如何备份数据库连接配置？**
+
+A: 复制配置文件即可：
+```bash
+# Windows
+copy C:\Users\用户名\.db-tool\connections.json D:\backup\
+
+# Mac/Linux
+cp ~/.db-tool/connections.json ~/backup/
+```
+
+### 更新和卸载
+
+**Q: 如何更新到最新版本？**
+
+A: 重新安装即可：
+```bash
+npm update -g fdb2
+```
+
+**Q: 如何完全卸载？**
+
+A: 执行以下步骤：
+```bash
+# 卸载程序
+npm uninstall -g fdb2
+
+# 删除数据目录（可选，会删除所有连接配置）
+# Windows
+rmdir /s C:\Users\用户名\.db-tool
+
+# Mac/Linux
+rm -rf ~/.db-tool
+```
+
+## 高级技巧
+
+### 批量操作
+
+**批量执行 SQL 文件：**
+```sql
+-- 创建一个 .sql 文件
+USE my_database;
+UPDATE users SET status = 'active' WHERE id > 100;
+DELETE FROM logs WHERE created_at < '2024-01-01';
+```
+
+然后在 SQL 查询页面复制粘贴执行。
+
+### 数据导出技巧
+
+**导出特定字段：**
+```sql
+SELECT id, name, email FROM users WHERE status = 'active';
+```
+
+**导出并格式化数据：**
+```sql
+SELECT 
+  id,
+  name,
+  DATE_FORMAT(created_at, '%Y-%m-%d') as created_date
+FROM users;
+```
+
+### 性能监控
+
+**查看表大小：**
+```sql
+-- MySQL
+SELECT 
+  table_name,
+  ROUND(((data_length + index_length) / 1024 / 1024), 2) AS size_mb
+FROM information_schema.tables
+WHERE table_schema = 'your_database';
+
+-- PostgreSQL
+SELECT 
+  schemaname,
+  tablename,
+  pg_size_pretty(pg_total_relation_size(schemaname||'.'||tablename)) AS size
+FROM pg_tables
+WHERE schemaname = 'public';
+```
+
+## 获取帮助
+
+- **GitHub Issues**: [提交问题](https://github.com/yourusername/fdb2/issues)
+- **文档**: 查看在线文档
+- **社区**: 加入用户交流群
 
 ---
 
-*本项目基于template脚手架构建，提供类似Navicat Premium的数据库管理体验。*
+**享受使用数据库管理工具！如有任何问题，欢迎反馈。**

package/bin/fdb2.js

@@ -32,37 +32,54 @@ switch (command) {
 function startProject() {
   console.log('Starting FDB2 project...');
   
+  // 检查 PID 文件是否存在，如果存在则说明服务器已经在运行
+  const pidFilePath = path.join(projectRoot, 'server.pid');
+  if (fs.existsSync(pidFilePath)) {
+    try {
+      const pid = parseInt(fs.readFileSync(pidFilePath, 'utf8'));
+      process.kill(pid, 0);
+      console.log('Server is already running with PID:', pid);
+      return;
+    } catch (error) {
+      if (error.code === 'ESRCH') {
+        console.log('Cleaning up stale PID file...');
+        fs.unlinkSync(pidFilePath);
+      }
+    }
+  }
+  
   // 命令和参数
   let cmd, args;
   
-  // 根据不同的操作系统选择不同的命令
-  if (process.platform === 'win32') {
-    // Windows 系统
-    cmd = 'cmd.exe';
-    args = ['/c', 'node', 'server.js', ...commandArgs];
-  } else {
-    // Linux/macOS 系统
-    cmd = 'node';
-    args = ['server.js', ...commandArgs];
-  }
+  // 直接使用 node 命令启动服务器
+  cmd = 'node';
+  args = ['server.js', ...commandArgs];
   
   console.log('Executing:', cmd, args);
   
-  // 使用 node 命令启动服务器
-  const result = spawnSync(cmd, args, {
+  // 日志文件路径
+  const logFilePath = path.join(projectRoot, 'server.log');
+  
+  // 创建日志文件的写入流
+  const out = fs.openSync(logFilePath, 'a');
+  const err = fs.openSync(logFilePath, 'a');
+  
+  // 使用 node 命令启动服务器（异步，后台运行）
+  const child = spawn(cmd, args, {
     cwd: projectRoot,
-    stdio: 'inherit'
+    detached: true,
+    stdio: ['ignore', out, err]
   });
   
-  if (result.error) {
-    console.error('Failed to start server:', result.error.message);
-    process.exit(1);
-  } else if (result.status === 0) {
-    console.log('Server started successfully');
-  } else {
-    console.error('Failed to start server with code', result.status);
-    process.exit(1);
-  }
+  // 解除父子进程关联，让子进程在后台独立运行
+  child.unref();
+  
+  // 保存 PID 到文件
+  fs.writeFileSync(pidFilePath, child.pid.toString());
+  
+  console.log('Server started successfully with PID:', child.pid);
+  console.log('Server is running in the background');
+  console.log('Logs are written to:', logFilePath);
 }
 
 // 停止项目