sql2gpt

SQL2GPT

SQL2GPT是一种基于Python的工具，可提取SQL数据库的架构，并为OpenAI的大型语言模型生成Chatgpt的提示。该项目的目的是使用户与Chatgpt进行交互以生成代码或询问与给定数据库架构有关的问题。

目录

• 先决条件
• 安装
• 用法
  • 添加数据库连接
  • 打印模式
  • 生成chatgpt提示
• 执照

先决条件

• Python 3.11或更高
• MySQL客户端（用于MySQL数据库）
• Pipenv：Python依赖性管理工具

安装

首先，克隆存储库：

git clone https://github.com/chand1012/sql2gpt.git
cd sql2gpt

确保已安装Pipenv。如果您没有安装它，则可以使用PIP安装它：

pip install pipenv

安装了PipEnv后，设置环境并安装依赖项：

pipenv install

要激活虚拟环境，请运行：

pipenv shell

用法

添加数据库连接

通过运行添加新的数据库连接：

python sql2gpt.py add < name > < database_uri >

其中<name>是您要给连接的名称，而<database_uri>是数据库的URI，例如：

• PostgreSQL： postgresql://username:password@localhost/dbname
• mySQL： mysql://username:password@localhost/dbname
• sqlite： sqlite:///example.db

打印模式

要打印数据库的模式，请运行：

python sql2gpt.py print_schema < database_url or name >

将<database_url>替换为SQL数据库的适当数据库URL或您之前添加的连接名称。

生成chatgpt提示

要生成给定数据库的chatgpt提示，请运行：

python sql2gpt.py get_prompt < database_url or name >

将<database_url>替换为SQL数据库的适当数据库URL或您之前添加的连接名称。生成的提示可以传递给chatgpt以获取代码或有关数据库的问题。

执照

该项目已根据MIT许可获得许可。