dsh-plugin-nlbi
DeepSeek Harness 的自然语言查询 + 商业智能报表插件：在 dsh-mysql 连接底座之上，提供 Text2SQL 自然语言查库、15+ 图表类型、Dashboard 仪表盘、指标/维度管理、多维分析、自助分析、报表导出、审计日志与数据权限。
插件会安装到这里；不确定时保持 web。
npx -y @deepseek-ai/dsh plugin --profile web add dsh-plugin-nlbi@0.2.1Plugin Nlbi 以 dsh-plugin-nlbi 发布，当前版本为 0.2.1。Plugin Hub 会校验它的 manifest，并保存精确安装来源，便于复现安装结果。
Natural-language data queries + BI reports for DeepSeek Harness.
在 DeepSeek Harness 对话里，用自然语言问数据库；答案不只是文字，而是「可编辑的 SQL + 可交互的数据表格 + 可复用的 BI 图表/报表」。
基于 dsh-mysql (v0.1.4) 连接底座二次开发，保留全部既有功能的同时，新增 Text2SQL、BI 图表、报表收藏、侧栏数据面板（借鉴 IDEA Database 工具窗）。
| 工具 | 用途 |
|---|---|
mysql_query | 只读查询（SELECT/SHOW/DESCRIBE/EXPLAIN，单语句，白名单，超时，2000 行上限） |
mysql_tables | 查看表结构（information_schema，受白名单约束） |
mysql_execute | 写操作（INSERT/UPDATE/DELETE，需连接开启 allowWrite） |
| 能力 | 说明 |
|---|---|
🔍 nl_query | Text2SQL：自然语言→SQL 生成→AST 校验→护栏执行→结果表格+图表 |
📊 sql_to_chart | 对查询结果自动生成 BI 图表规格，支持柱/折线/饼/统计卡 |
| 💾 报表收藏 | save_report / list_reports / delete_report / rerun_report，含重跑与导出 |
| 🗂 数据浏览器 | 右侧栏 SchemaTree（表结构导航树）+ GridPanel（数据网格预览，分页/排序/WHERE 过滤） |
| 🎤 智能查询 | 右侧栏自然语言输入框，即时查询 + 一键"发到对话" |
| 📋 报表库 | 右侧栏自然语言生成报表 → 收藏 → 重跑/导出/删除 |
nl_query 强制只读（即使连接开了写权限）MAX_EXECUTION_TIME(15000)、2000 行截断# 从 npm 安装最新稳定版（推荐）
dsh plugin --profile web add dsh-plugin-nlbi@latest
# 或固定安装当前版本
dsh plugin --profile web add dsh-plugin-nlbi@0.2.1
# 重启 DSH（仅当当前没有实例运行时）
dsh web
npm package: https://www.npmjs.com/package/dsh-plugin-nlbi
如果启动时提示
EADDRINUSE: address already in use 127.0.0.1:3080，说明 DSH Web 已经运行，直接打开 http://127.0.0.1:3080，不要重复执行dsh web。
pnpm pack
dsh plugin --profile web add ./dsh-plugin-nlbi-0.2.1.tgz
要使用右侧栏全能工作台，建议安装侧栏支持插件：
# 安装 dsh-better-sidebar（推荐，轻量）
dsh plugin --profile web add dsh-better-sidebar
# 或安装 @linxin666/dsh-web-ui-all（功能更全）
dsh plugin --profile web add @linxin666/dsh-web-ui-all
# 重启 DSH
dsh --profile web
不安装前置插件也能使用本插件的核心功能：🐬 输入栏连接选择、💬 对话中
nl_query/mysql_query工具、设置页连接管理。
http://127.0.0.1:3080方式 A：对话中自然语言查库
用户：上个月每天的订单量是多少？
Agent：调用 nl_query → 生成 SQL → 返回表格 + 图表
方式 B：右侧栏全能工作台 打开右侧栏 → 🛢 Nlbi 数据库 tab，内含 3 个子区：
| 子区 | 功能 |
|---|---|
| 🔍 智能查询 | 输入自然语言 → 即时出表格+图表 → 可一键"发到对话" |
| 🗂 数据浏览 | 双击左侧表名 → 右侧数据网格（分页/排序/WHERE 过滤） |
| 📊 报表 | 自然语言描述 → 生成图表 → 收藏 → 重跑/导出/删除 |
右侧栏工作台（智能查询 / 数据浏览 / 报表 三合一）
┌─────────────────────────────────────────────┐
│ 🔌 dsh-test · dsh_test ▼ │
│ [🔍 智能查询] [🗂 数据浏览] [📊 报表] │
├─────────────────────────────────────────────┤
│ 💬 查询所有用户 │
│ [🔍 查询] [💬 发到对话] │
│ 💡 查询所有用户 💡 统计各分类商品数量 │
│ 💡 上个月每天的订单量 💡 订单最多的前5个用户 │
│ ┌─ 生成 SQL（只读）──────────────────────┐ │
│ │ SELECT * FROM users LIMIT 2000 │ │
│ │ [复制 SQL] [💾 收藏为报表] │ │
│ └────────────────────────────────────────┘ │
│ ┌─ [表格 (50)] [图表] ────────────────────┐ │
│ │ id │ name │ email │ status │ created_at │ │
│ │ 1 │ 张三 │ ... │ active │ 2026-... │ │
│ └─────────────────────────────────────────┘ │
└─────────────────────────────────────────────┘
┌───────────────────────────── DSH Web 浏览器 ─────────────────────────────┐
│ │
│ lib/client.js（单文件 bundle，React 无 JSX） │
│ ├─ 🐬 输入栏连接选择器（会话级） │
│ ├─ ⚙️ 设置页「Nlbi 数据库」连接管理 │
│ ├─ 📊 BI 结果渲染（对话输出渲染表格/图表） │
│ └─ 🛢 右侧栏全能工作台（智能查询/数据浏览/报表） │
└───────────────┬────────────────────────────────────────────┬──────────────┘
│ │
┌───────────────▼──────────────── DSH Host (Node) ──────────▼──────────────┐
│ lib/index.js（连接管理 + 5 工具 + 14 RPC 服务） │
│ │
│ 新增模块： │
│ ├─ sqlsafe.js AST 级 SQL 安全校验（分类/白名单/LIMIT 改写/一站式） │
│ ├─ text2sql.js Text2SQL 编排（Schema 注入/LLM 调用/JSON 解析/护栏执行） │
│ └─ chart.js BI 图表规格生成（5 类场景启发式） │
│ │
│ 工具：mysql_query / mysql_tables / mysql_execute / nl_query / sql_to_chart │
└────────────────────────────────────────────────────────────────────────────┘
| 层 | 技术 | 说明 |
|---|---|---|
| 运行时 | Node.js ESM + Cordis 4 | DSH 插件框架 |
| SQL 解析 | node-sql-parser v5.4 | AST 级 SQL 分类/校验/改写 |
| 图表渲染 | ECharts（CDN 加载） | 柱/折线/饼/统计卡，失败降级 SVG |
| 数据库 | mysql2 | 连接池、预处理、JSON 安全序列化 |
| 校验 | zod v4 | Typert RPC 网关边界校验 |
| 前端 | React 无 JSX | 单文件 bundle，CSS 主题变量跟随 DSH |
cd dsh-plugin-nlbi
# 语法检查
node --check lib/index.js lib/shared.js lib/sqlsafe.js lib/text2sql.js \
lib/chart.js lib/typert.host.js lib/client.js
# 运行全部测试
node test/shared.test.mjs
node test/sqlsafe.test.mjs
node test/text2sql.test.mjs
node test/chart.test.mjs
当前测试覆盖：69 组断言，全部通过 ✅
# 克隆
git clone https://github.com/1byteone/dsh-plugin-nlbi.git
cd dsh-plugin-nlbi
# 安装依赖
pnpm install
# 本地打包安装
pnpm pack
dsh plugin --profile web add dsh-plugin-nlbi-*.tgz
# 重启 DSH
dsh --profile web
| 限制 | 说明 | 计划 |
|---|---|---|
| Text2SQL 需要 LLM 模型 | nl_query 依赖 DSH 的 llm 服务（DeepSeek / OpenAI 等） | 已适配 DSH 标准模型路由 |
| 图表导出 | 当前仅支持 SQL 导出（Markdown） | 路线图：HTML/PNG 导出 |
| 仅 MySQL | 继承上游，仅支持 MySQL | 路线图：PostgreSQL 支持 |
| 侧栏依赖 betterSidebar | 需要 @linxin666/dsh-web-ui-all 提供 | 已做降级，无侧栏时功能仍可从设置页使用 |
MIT
Forked from dsh-mysql (v0.1.4, MIT) by 1321928757.