Files
opsxdb/apps/server/internal/docs/content/02-quickstart.md
T
logan a9510235bb
CI / Go server (push) Canceled after 0s
CI / Web + core packages (push) Canceled after 0s
CI / Desktop (Tauri) cargo check (push) Canceled after 0s
feat: 18 引擎驱动全家桶 + 驱动管理/离线包 + 设置中心 + 工作台交互打磨
驱动接入(全部本机真实例验收):
- Elasticsearch 原生 SQL API、InfluxDB 原生 HTTP+Flux(官方 JDBC 付费许可,实测弃用)
- ZooKeeper/MongoDB JVM agent(连接时自动下载官方驱动 jar,sha256 钉版本到 ~/.opsxdb/drivers/)
- 达梦 JDBC agent 桥就绪(待厂商 jar+实例);TiDB 真实例验收
- 协议族代码审查放行 PolarDB/TDSQL/OceanBase/Kingbase/GaussDB/Oracle
- 驱动能力模型:按驱动开关对象树分组/右键菜单/行编辑,NoSQL 树拍平(对象直挂库节点)

驱动管理:
- 驱动管理弹框(状态/预装/离线包导入/JDK 检测)+ /api/drivers/* 三接口
- opsxdb-driver 驱动商店仓库(清单/fetch.sh/pack.sh 离线包/import.sh)
- 连接时懒加载:DMG 零 Java 产物,首连自动下载(实测 ZK 九件套 1.35s),离线包自动回退

UI/交互:
- 设置中心(⚙):常规/执行/结果/驱动/快捷键/关于,左导航+右面板(对标 opsxshell)
- 实例级展开箭头(行首 SVG chevron,替代字体回退失真的 Unicode 三角)
- 树内嵌套渲染修复:对象树挂在激活连接下;工具栏窄窗口不断行(按钮 nowrap+整颗换行)
- 侧栏连接行精简(图标+连接名)、SQLite SSH 守卫、Oracle 死参数清理

质量:
- Go 协议层/离线回退单测、E2E 门控测试(ES/ZK/Influx/Mongo/TiDB/JDBC 桥)
- 驱动注册表单一事实来源 connection-types.json,README/BACKLOG/AGENTS 同步
2026-09-22 01:07:46 +08:00

1.9 KiB
Raw Blame History

本章从零到出结果:起服务 → 建连接 → 执行第一条 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

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