OpsxDB 文档 v0.1

快速开始

更新于 2026-09-20

本章从零到出结果:起服务 → 建连接 → 执行第一条 SQL。

1. 启动

桌面版(主交付形态)双击 OpsxDB 应用即可,本地后端随应用自动拉起。

从源码运行(开发):

git clone <repo> opsxdb && cd opsxdb
npm install

./run.sh gui    # 桌面形态(开发):Tauri 窗口 + 本地后端
./run.sh web    # 仅启动官网与文档 → http://127.0.0.1:8788/
./run.sh package  # 打桌面安装包(DMG,内嵌后端)

注意:客户端只在桌面 App 里运行。./run.sh gui 起的 :5174 是桌面 devUrl 的资产服务,不是浏览器客户端;浏览器只用于官网 / 与文档 /docs(后端 :8788 直接提供)。

2. 新建连接

  1. 打开应用,进入连接选择器,选择数据库类型(如 MySQL);

  2. 或者直接粘贴连接 URL,点「填入」自动拆解字段:

    mysql://root:pass@127.0.0.1:3306/shop
    
  3. 点 测试 验证连通性,再点 保存并连接。

连接配置保存在本机,密码混淆存储;后续查询只携带会话 ID,不再上送账密。

3. 第一次查询

  1. 左侧对象树展开库,点表名直接查看前 100 行(展开表可看列结构);

  2. 打开 SQL 编辑器,输入:

    SELECT * FROM orders ORDER BY id DESC LIMIT 100;
    
  3. 按 ⌘/Ctrl + Enter 执行当前语句(或选中的片段);

  4. 结果面板支持复制 / 导出 CSV / 生成 INSERT,双击单元格即复制。

4. 验证服务

curl -s http://127.0.0.1:8788/health
# {"ok":true,"service":"opsxdb"}

5. 手边没有数据库?

本地还没有可连的库?用仓库自带的辅助脚本一键起一个(需要 Docker,一次只起一个):

./tests/dbctl.sh up a    # MySQL
./tests/dbctl.sh up c    # PostgreSQL(用户 opsx)
./tests/dbctl.sh up f    # Redis

各驱动的验收状态见《驱动支持》。