Files
opsxdb/apps/server/internal/docs/content/02-quickstart.md
T
logan 26f459d1b8 fix: 顶栏文案去重与文档/连库体验更新
顶栏定为:连接 · 新建连接 · 新建查询 · 查询历史 · 快捷键;
同步 docs/落地页、对象树与 connection-types 注册表整理。
2026-09-20 16:32:29 +08:00

62 lines
1.8 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
本章从零到出结果:起服务 → 建连接 → 执行第一条 SQL。
## 1. 启动
桌面版(主交付形态)双击 OpsxDB 应用即可,本地后端随应用自动拉起。
从源码跑 Web / 桌面形态:
```bash
git clone <repo> opsxdb && cd opsxdb
npm install
./run.sh web # Web 形态:Gin :8788 + Vite 开发壳 :5174
./run.sh gui # 桌面形态:Tauri 2 窗口(复用同一套界面)
```
> **注意**:浏览器里的 `:5174` 是 Vite 热更新开发壳,仅调试用;产品页面(官网 `/`、文档 `/docs`)由后端 `:8788` 直接提供。
## 2. 新建连接
1. 打开应用,进入**连接选择器**,选择数据库类型(如 MySQL);
2. 或者直接粘贴连接 URL,点「填入」自动拆解字段:
```
mysql://root:pass@127.0.0.1:3306/shop
```
3. 点 **测试** 验证连通性,再点 **保存并连接**。
连接配置保存在本机,密码混淆存储;后续查询只携带会话 ID,不再上送账密。
## 3. 第一次查询
1. 左侧对象树展开库,**点表名**直接查看前 100 行(展开表可看列结构);
2. 打开 SQL 编辑器,输入:
```sql
SELECT * FROM orders ORDER BY id DESC LIMIT 100;
```
3. 按 **⌘/Ctrl + Enter** 执行当前语句(或选中的片段);
4. 结果面板支持**复制 / 导出 CSV / 生成 INSERT**,双击单元格即复制。
## 4. 验证服务
```bash
curl -s http://127.0.0.1:8788/health
# {"ok":true,"service":"opsxdb"}
```
## 5. 手边没有数据库?
本地还没有可连的库?用仓库自带的辅助脚本一键起一个(需要 Docker,一次只起一个):
```bash
./tests/dbctl.sh up a # MySQL
./tests/dbctl.sh up c # PostgreSQL(用户 opsx)
./tests/dbctl.sh up f # Redis
```
各驱动的验收状态见《驱动支持》。