# rookie_text2data

**Repository Path**: os-share/rookie_text2data

## Basic Information

- **Project Name**: rookie_text2data
- **Description**: dify 插件，自然语言获取数据库数据 。
原始链接：https://github.com/jaguarliuu/rookie_text2    
参考：https://www.bilibili.com/video/BV1E7dyYvEpb
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-07-08
- **Last Updated**: 2025-07-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## rookie_text2data

**Author:** jaguarliuu
**Version:** 0.3.1
**Type:** tool

### Description
将自然语言转换为安全、优化的 SQL 查询工具，支持 MySQL 和 PostgreSQL 数据库。


### 声明
承蒙厚爱，没有想到一个偶然的想法和基础实践受到这么多人的关注，在此表示感谢！
会积极完善插件，欢迎大家提出宝贵意见！

为方便交流，搞个交流群，大家一起交流学习！


> Contact:
>  - Wechat： L1763077056

### ✨ 核心特性

#### ​**多数据库支持**
- 原生支持 MySQL 和 PostgreSQL 语法差异
- 自动识别数据库类型生成适配的 SQL 语法（如 `LIMIT` vs `FETCH FIRST`）

#### ​**安全防护**
- 强制结果集限制（默认 `LIMIT 100`）
- 禁止 DML 操作（仅允许 SELECT 语句）
- 字段白名单验证（基于数据库元数据）
- 使用最小权限原则执行查询


### 数据库支持
- MySQL
- PostgreSQL

### 大模型支持

> 理论上，支持所有**非深度思考**大模型

- ChatGLM-6B
- DeepSeek V3
- Qwen-max
- ...

### 快速开始
#### SQL生成组件
1. 引入 rookie_text2data 插件
2. 完成基础参数配置

| 参数名    | 类型     | 必填 | 描述                           | 多语言支持                |
|-----------|----------|------|--------------------------------|---------------------------|
| db_type   | select   | 是   | 数据库类型（MySQL/PostgreSQL） | 中/英/葡                  |
| host      | string   | 是   | 数据库主机地址                 | 中/英/葡                  |
| port      | number   | 是   | 数据库端口（1-65535）          | 中/英/葡                  |
| db_name   | string   | 是   | 目标数据库名称                 | 中/英/葡                  |
| table_name| string   | 否   | 多表逗号分隔（空则全库）       | 中文含格式说明            |

3. 选择模型
推荐使用`Qwen-max`模型，其他模型请自行尝试。不支持深度思考模型。
4. 使用自然语言生成 SQL 查询语句

#### SQL执行组件
1. 引入 rookie_excute_sql 插件
2. 完成基础参数配置

| 参数名    | 类型     | 必填 | 描述                           | 多语言支持                |
|-----------|----------|------|--------------------------------|---------------------------|
| db_type   | select   | 是   | 数据库类型（MySQL/PostgreSQL） | 中/英/葡                  |
| host      | string   | 是   | 数据库主机地址                 | 中/英/葡                  |
| port      | number   | 是   | 数据库端口（1-65535）          | 中/英/葡                  |
| db_name   | string   | 是   | 目标数据库名称                 | 中/英/葡                  |
| sql       | string   | 是   | SQL 查询语句                   | 中/英/葡                  |


3. 点击执行，执行 sql 语句

### 许可证

本项目采用 Apache License 2.0 许可证 - 查看 [LICENSE](LICENSE) 文件了解详细信息。