sql-translator

SQL Translator 项目介绍

SQL Translator 是一个旨在简化 SQL（结构化查询语言）与自然语言之间相互转换的工具。SQL 常用于管理和操作关系型数据库中的数据，尽管功能强大，但对很多人来说，SQL 的语法复杂且难以理解。而自然语言则是我们平常使用的口语和书面语言，对不熟悉技术术语的人更为友好。

这个工具的出现，完全开放且免费的，旨在打破专业壁垒。用户无需精通 SQL，也能轻松了解数据库中发生的情况或者编写 SQL 查询。用户只需用自然语言输入查询，工具会自动生成对应的 SQL 代码，反之亦然。

🌟 功能特色

• 暗模式：适合在低光环境下工作。
• 大小写切换：方便调整代码格式。
• 复制到剪贴板：快速复制生成的代码。
• SQL 语法高亮：确保代码易读性。
• 模式感知（Beta 版）：能根据表结构生成更精准的查询。
• 查询历史：保留过去的查询记录，方便查阅。

📖 使用说明

使用 SQL Translator 非常简单。用户只需访问工具的官网，选择要转换的方向（自然语言到 SQL 或 SQL 到自然语言），然后输入查询语句并点击“翻译”按钮。工具会生成相应的代码或文本，并显示在屏幕上。如果需要输入自然语言来获取 SQL 查询，还可以按下“反向”按钮。

🎯 项目规划

• 函数转换（正在进行）
• 过程转换

🛠️ 安装指南

本地开发环境

1. 克隆仓库：

   git clone https://github.com/whoiskatrin/sql-translator.git
   

2. 安装所需的软件包：

   cd sql-translator
   npm install
   

3. 编译应用：

   npm run build
   

4. 在 .env 文件中输入你的 OPENAI API 密钥。可以在 这里 获取 API 密钥：

   OPENAI_API_KEY=$YOUR_API_KEY
   

5. 启动开发服务器：

   npm start
   

使用 Docker Compose

1. 克隆仓库：

   git clone https://github.com/whoiskatrin/sql-translator.git
   

2. 在 .env.production 文件中输入你的 OPENAI API 密钥。可以在 这里 获取 API 密钥：

   OPENAI_API_KEY=$YOUR_API_KEY
   

3. 启动开发服务器：

   docker-compose up
   

🖥️ 使用方法

在开发服务器运行后，可以通过浏览器访问 http://localhost:3000 来使用该应用。在输入框中输入自然语言查询，然后点击“翻译”按钮生成对应的 SQL 代码。生成的 SQL 代码将显示在输出框中。

👥 项目贡献

我们欢迎任何人对 SQL Translator 的贡献！如需贡献，请按以下步骤进行：

1. Fork 仓库
2. 创建新分支
3. 做出修改
4. 将更改推送到你的 fork
5. 提交一个 Pull Request

📜 许可协议

SQL Translator 遵循 MIT 许可证发布，详细信息参见 License。