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 同步
This commit is contained in:
logan committed
1 parent
26f459d1b8
commit
a9510235bb
156 files changed
+17200
-2520
No files matched your search
@@ -15,7 +15,7 @@ OpsxDB 是一款**本地优先**的桌面数据库工作台，面向运维与开
|
||||
| 安全通道 | 每连接独立配置 SSL/TLS 与 SSH 隧道；密码本机混淆存储 |
|
||||
| AI 面板 | 生成 / 解释 / 优化 / 修复 / 方言转换 / 样例 SQL |
|
||||
| 危险操作防护 | DROP / TRUNCATE / 无 WHERE 的 UPDATE·DELETE 执行前确认 |
|
||||
| 双形态 | 桌面 GUI（Tauri 2）与 Web（单二进制 + 静态页）共用一套界面 |
|
||||
| 桌面唯一形态 | 桌面 GUI（Tauri 2），本地后端随应用自动拉起 |
|
||||
|
||||
## 支持的数据库
|
||||
|
||||
@@ -33,7 +33,7 @@ OpsxDB 是一款**本地优先**的桌面数据库工作台，面向运维与开
|
||||
## 为什么选 OpsxDB
|
||||
|
||||
- **数据主权**：连接配置与查询历史只存在本机；后端默认仅监听 127.0.0.1。
|
||||
- **开箱即用**：`./run.sh web` 一条命令起 Web 形态；桌面版双击即用，后端随应用拉起。
|
||||
- **开箱即用**：桌面版双击即用，本地后端随应用自动拉起；官网与文档也由它内置提供。
|
||||
- **为快设计**：点表即看数据、⌘Enter 即执行、结果三键取走（复制 / CSV / INSERT）。
|
||||
- **轻量克制**：一个 Go 二进制 + 一份前端，内网可部署，无遥测无账号。
|
||||
|
||||
|
||||
@@ -4,17 +4,18 @@
|
||||
|
||||
桌面版（主交付形态）双击 OpsxDB 应用即可，本地后端随应用自动拉起。
|
||||
|
||||
从源码跑 Web / 桌面形态：
|
||||
从源码运行（开发）：
|
||||
|
||||
```bash
|
||||
git clone <repo> opsxdb && cd opsxdb
|
||||
npm install
|
||||
|
||||
./run.sh web # Web 形态：Gin :8788 + Vite 开发壳 :5174
|
||||
./run.sh gui # 桌面形态：Tauri 2 窗口（复用同一套界面）
|
||||
./run.sh gui # 桌面形态（开发）：Tauri 窗口 + 本地后端
|
||||
./run.sh web # 仅启动官网与文档 → http://127.0.0.1:8788/
|
||||
./run.sh package # 打桌面安装包（DMG，内嵌后端）
|
||||
```
|
||||
|
||||
> **注意**：浏览器里的 `:5174` 是 Vite 热更新开发壳，仅调试用；产品页面（官网 `/`、文档 `/docs`）由后端 `:8788` 直接提供。
|
||||
> **注意**：客户端只在桌面 App 里运行。`./run.sh gui` 起的 `:5174` 是桌面 devUrl 的资产服务，不是浏览器客户端；浏览器只用于官网 `/` 与文档 `/docs`（后端 `:8788` 直接提供）。
|
||||
|
||||
## 2. 新建连接
|
||||
|
||||
|
||||
@@ -24,6 +24,7 @@ OpsxDB 的界面为「高频操作」设计：从打开应用到看到数据，
|
||||
|
||||
- 点**表名**：直接打开前 100 行数据；
|
||||
- 展开**表**：查看列结构；
|
||||
- Redis：按键分隔符编文件夹，点键打开类型化详情（TTL / JSON / 增删字段）；
|
||||
- 库列表懒加载，大实例也不卡。
|
||||
|
||||
## 编辑器与结果
|
||||
|
||||
@@ -20,7 +20,7 @@ postgres://opsx:pass@127.0.0.1:5432/app
|
||||
| MySQL / PostgreSQL / SQL Server | standard | host · port · user · password · database · ssl · ssh |
|
||||
| Oracle | oracle | host · port · user · password · **service**（如 ORCL） |
|
||||
| SQLite | file | database 填本地文件路径（如 `~/data/demo.sqlite`） |
|
||||
| Redis | redis | host · port · password · database 序号 |
|
||||
| Redis | redis | host · port · password · database 序号 · **模式**（单机 / 哨兵 / 集群）· 键分隔符 |
|
||||
|
||||
表单只收集服务端实际消费的字段；历史遗留的死参数不会出现在表单里。
|
||||
|
||||
@@ -39,4 +39,12 @@ postgres://opsx:pass@127.0.0.1:5432/app
|
||||
|
||||
数据库在跳板机后面时，开启 **ssh** 字段组，填写跳板机地址与凭据：OpsxDB 会先建 SSH 隧道，再把数据库连接走隧道转发，无需把库端口暴露到公网。
|
||||
|
||||
## Redis 哨兵与集群
|
||||
|
||||
- **哨兵**：模式选 Sentinel，填写 Sentinel 节点列表（`host:port`，多行）和主节点名 `masterName`；
|
||||
- **集群**：模式选 Cluster，填写至少一个种子节点。对象树只显示 DB 0（Cluster 无 `SELECT`）；
|
||||
- 单机模式只填 host/port，与原先一致。
|
||||
|
||||
字段细节与键浏览见 [Redis 工作台](redis)。
|
||||
|
||||
> **提示**：连接保存后，后续查询仅携带 `sessionId`，账密不会随每次请求上送；密码在本机混淆存储。
|
||||
@@ -4,6 +4,7 @@ SQL 工作台是日常使用率最高的界面，所有交互围绕「快」设
|
||||
|
||||
- **⌘/Ctrl + Enter**：执行光标所在的**当前语句**；有选区时执行**选区**；
|
||||
- 不是「整页脚本」模式 —— 多条语句互不干扰，想跑哪句把光标放哪；
|
||||
- Redis 连接共用同一编辑器，按**行**执行命令（见 [Redis 工作台](redis)），不另开 CLI；
|
||||
- 执行在会话上运行，连接断开后自动提示。
|
||||
|
||||
## 多 Tab 与分栏
|
||||
|
||||
@@ -1,34 +1,93 @@
|
||||
Redis 连接使用专用表单（redis），连上后既是命令行又是键空间浏览器。
|
||||
Redis 连接使用专用表单（redis）。连上后，对象树是键空间浏览器，编辑器是 Redis 命令行 —— **和 SQL 共用同一套输入框**，不另开 CLI 页。
|
||||
|
||||
## 为什么命令行不单独做一套
|
||||
|
||||
SQL 工作台已经有：多 Tab、⌘/Ctrl+Enter、查询历史、书签、危险确认、取消。Redis 命令同样是「输入 → 执行 → 结果表」。
|
||||
|
||||
拆成独立 CLI（终端 REPL）会让快捷键、历史、危险确认分叉，也和 Navicat 式多引擎工作台不一致。
|
||||
|
||||
因此：
|
||||
|
||||
| | SQL | Redis |
|
||||
| --- | --- | --- |
|
||||
| 输入框 | 同一 CodeMirror | 同一 CodeMirror（占位/补全换成命令） |
|
||||
| 切分 | 分号语句 | **按行**（`SET k "a;b"` 不会被分号拆开） |
|
||||
| 执行 | ⌘/Ctrl+Enter 当前语句或选区 | ⌘/Ctrl+Enter 当前行或选区 |
|
||||
| 结果 | 结果表 | 命令结果表；从对象树打开键则进入键详情 |
|
||||
|
||||
Another Redis Desktop Manager 的独立 CLI Tab、opsxsql 的单行命令 + 输出日志，列为后续 P1，不是现在的主路径。
|
||||
|
||||
## 键空间浏览
|
||||
|
||||
对象树对 Redis 显示 DB0–15（Cluster 仅 0）。展开库后：
|
||||
|
||||
- **SCAN 过滤**：输入 `user:*` 点「应用」；生产大库请带前缀，避免扫全库。最多展示 500 个键，超出提示截断。
|
||||
- **按分隔符编文件夹**：连接表单的「键分隔符」默认 `:`，`CEX:FOLLOW:FOLLOWERS:1` 显示为 `CEX / FOLLOW / FOLLOWERS / 1`。文件夹显示数量；右键可「只看此前缀」「在此新建键」。
|
||||
- **类型色点**：string 绿 / hash 蓝 / list 橙 / set 紫 / zset 青。
|
||||
- **点键**：打开键详情（不是假 SELECT）。
|
||||
|
||||
## 键详情
|
||||
|
||||
对标 Another Redis Desktop Manager 的 Hash/List/Set 视图：
|
||||
|
||||
- 类型徽章、键名（回车重命名）、TTL（回车或「保存 TTL」，`-1` 永久）、刷新、导出还原命令、删除；
|
||||
- **结构**表：Hash 为 ID / Field / Value，JSON 值自动美化；可新增字段、编辑、删除；
|
||||
- **JSON** 视图：整体格式化；
|
||||
- 表内关键字过滤。
|
||||
|
||||
String 可直接改值保存。
|
||||
|
||||
## 命令执行
|
||||
|
||||
SQL 编辑器同样适用于 Redis —— 直接输入命令，⌘/Ctrl + Enter 执行：
|
||||
编辑器直接写 Redis 命令：
|
||||
|
||||
```bash
|
||||
PING
|
||||
SET demo:key "hello" EX 60
|
||||
GET demo:key
|
||||
KEYS demo:*
|
||||
DEL demo:key
|
||||
HGETALL demo:hash
|
||||
SCAN 0 MATCH demo:* COUNT 100
|
||||
INFO memory
|
||||
```
|
||||
|
||||
- 返回值直接显示在结果面板；
|
||||
- 集群 / 哨兵模式按各自连接方式配置（哨兵填写主节点名）。
|
||||
- 未点名的命令走通用 `Do`（`EXISTS` / `ECHO` / `INFO` / `CLIENT LIST` 等不必再加白名单）；
|
||||
- `FLUSHALL` / `FLUSHDB` / `KEYS` / `CONFIG` 仍要二段确认；
|
||||
- `KEYS *` 在大库上会阻塞 —— 请用 `SCAN MATCH`。
|
||||
|
||||
## 键空间浏览
|
||||
### 切换逻辑库（SELECT）
|
||||
|
||||
- **KEYS 扫描**：按模式浏览键（生产大库建议用前缀收窄范围）；
|
||||
- 键类型视图：string / hash / list / set / zset 分类型展示；
|
||||
- **TTL 管理**：查看与设置过期时间，常用于缓存排障；
|
||||
- 批量操作：选中多个键批量删除。
|
||||
`SELECT 1` 是 Redis 官方的切库命令，编辑器直接支持 —— 语义与 redis-cli 一致：**切换后本 Tab 的后续命令都在目标库执行**：
|
||||
|
||||
> **注意**：`KEYS *` 在大库上会阻塞 Redis，OpsxDB 不做强制拦截 —— 生产环境请自觉使用带前缀的模式。
|
||||
```bash
|
||||
SELECT 1
|
||||
GET db1:only:key # 在 db1 执行
|
||||
```
|
||||
|
||||
- 没有也没有 `USE`（那是 SQL 语法）—— 输入 `USE db1` 会得到 Redis 原生报错
|
||||
`ERR unknown command 'USE'`，与 redis-cli 行为一致；
|
||||
- 切库只影响当前查询 Tab（多 Tab 可各连各的库），左侧对象树点开对应库可浏览键；
|
||||
- Cluster 模式只有 DB 0，`SELECT` 无效。
|
||||
|
||||
## 连接参数
|
||||
|
||||
| 字段 | 说明 |
|
||||
| --- | --- |
|
||||
| host / port | 默认 127.0.0.1:6379 |
|
||||
| password | ACL / requirepass |
|
||||
| database | 逻辑库序号（0-15 常见） |
|
||||
| ssl | 红色连接（TLS）开关 |
|
||||
| host / port | 单机默认 127.0.0.1:6379 |
|
||||
| password / user | ACL / requirepass |
|
||||
| database | 逻辑库序号（0–15 常见；Cluster 忽略） |
|
||||
| 键分隔符 | 对象树文件夹分隔，默认 `:` |
|
||||
| ssl | TLS |
|
||||
| redisMode | `standalone`（默认）/ `sentinel` / `cluster` |
|
||||
| redisNodes | Sentinel / Cluster 节点列表，`host:port` 多行或逗号分隔 |
|
||||
| masterName | Sentinel 主节点名（必填） |
|
||||
| sentinelPassword | Sentinel 密码（可空） |
|
||||
|
||||
### Sentinel
|
||||
|
||||
模式选「哨兵」，填写至少一个 Sentinel 地址和 `masterName`（如 `mymaster`）。逻辑库序号仍可用。
|
||||
|
||||
### Cluster
|
||||
|
||||
模式选「集群」，填写至少一个种子节点。Cluster 不支持 `SELECT` 多库，对象树只暴露 DB 0。槽位路由由客户端处理，键浏览走 `SCAN`。
|
||||
|
||||
> **环境**：Sentinel / Cluster 表单与后端已接好；真实拓扑联调见 `docs/BACKLOG.md` 环境缺口。
|
||||
@@ -1,10 +1,10 @@
|
||||
## 产品形态
|
||||
|
||||
**Q：浏览器里的 5174 端口是什么？**
|
||||
Vite 热更新开发壳，仅开发调试用。产品形态是桌面应用（Tauri 2）或自托管 Web 服务，页面与 API 由后端 `:8788` 提供。
|
||||
**Q：能在浏览器里操作数据库吗？**
|
||||
不能。OpsxDB 客户端唯一形态是桌面 App（Tauri 2）；浏览器只承载官网与文档（由本地后端 `:8788` 内置提供）。开发时的 `:5174` 只是桌面 devUrl 的资产服务，不是网页客户端。
|
||||
|
||||
**Q：桌面版和 Web 版功能有差别吗？**
|
||||
没有。同一套 UI、同一份后端，桌面版只是多了应用壳（自动拉起本地后端、原生窗口、安装包形态）。
|
||||
**Q：官网和文档部署在哪？**
|
||||
就内置在你运行的那个二进制里：`http://127.0.0.1:8788/` 是官网，`/docs` 是文档；无需额外部署。
|
||||
|
||||
**Q：怎么打安装包？**
|
||||
`./run.sh package` 产出 Tauri 安装包（DMG）并内嵌 sidecar 后端二进制。
|
||||
|
||||
Reference in new issue
Block a user