项目介绍

欢迎来到 Doris，一个功能强大的自然语言处理 (NLP) 工具，专为数据查询和分析设计。Doris 能够将复杂的自然语言查询转换为高效的 SQL，并提供专业的数据分析服务。

功能特点

• 多表连接支持：轻松处理多个数据库表的复杂关系
• 智能上下文理解：基于历史查询和业务背景优化结果
• 可解释性输出：提供清晰易懂的结果说明，适合非技术人员使用
• 实时数据分析：快速响应用户查询并生成分析结果

安装指南

环境要求

• 操作系统：Linux、Windows 10 或更高版本
• 内存：至少 4GB RAM
• Python 版本：3.8 及以上版本

安装步骤

# 克隆仓库
git clone https://github.com/your-repository.git
cd Doris

# 安装依赖项
pip install -r requirements.txt

# 启动服务
python start_server.py

使用说明

基本用法

1. 初始化配置

   # 配置数据库连接信息
   configuresettings --database-settings
   

2. 执行查询

   # 执行单表查询
   doristool query "显示所有客户的联系信息"
   
   # 执行跨表联合查询
   doristool join-query "计算每个销售代表的季度销售额"
   

3. 获取结果

   • 查询结果将输出到控制台，并自动生成分析报告

高级功能

多步骤查询流程

1. 解析自然语言查询

   parse_query --query="显示2022年每位销售代表的总销售额"
   

2. 获取相似查询示例

   find_similar_examples --query="显示2022年每位销售代表的总销售额"
   

3. 生成优化SQL

   generate_sql --query="显示2022年每位销售代表的总销售额"
   

4. 执行并分析结果

   exec_query --sql="SELECT SUM(sales) AS total_sales, representative_id FROM sales GROUP BY representative_id;"
   analyze_query_result --resultsetId=123
   

配置选项

数据库配置

编辑 config/database_config.json 文件：

{
  "host": "localhost",
  "port": 3306,
  "user": "root",
  "password": "your_password",
  "databases": ["sales", "customer"]
}

日志设置

编辑 config/logging_settings.json 文件：

{
  "log_level": "INFO",
  "log_file": "doris.log"
}

错误处理

常见错误及解决方案：

1. 数据库连接失败

   • 检查数据库服务是否运行
   • 确认凭据信息无误

2. SQL执行超时

   • 优化查询语句
   • 调整索引策略

3. 分析结果为空

   • 验证查询条件
   • 检查数据完整性

贡献指南

欢迎通过提交问题或拉取请求为项目贡献力量。请参考 CONTRIBUTING.md 文件了解具体流程。

许可证

该项目遵循 MIT 许可证，具体内容如下：

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

附录

Doris 使用说明

Doris 提供以下主要工具：

• parse_query：解析自然语言查询
• find_similar_examples：获取相似查询示例
• generate_sql：生成优化 SQL 语句
• exec_query：执行 SQL 查询
• analyze_query_result：分析查询结果

工作流程图

开始
    |
    v
接收自然语言查询
    |
    v
parse_query
    |
    v
find_similar_examples（可选）
    |
    v
generate_sql
    |
    v
exec_query
    |
    v
analyze_query_result
    |
    v
输出结果和分析报告

示例

1. 基础查询

   doristool query "显示所有客户的联系信息"
   

2. 复杂查询

   doristool join-query "计算每个销售代表的季度销售额"
   

3. 自定义脚本

   from doris import DorisClient
   
   client = DorisClient()
   result = client.query("显示过去一年的订单总量")
   print(result)
   

感谢使用 Doris！如需帮助，请随时联系维护团队。