sql2gpt

SQL2GPT

SQL2GPTは、SQLデータベースのスキーマを抽出し、OpenAIによる大規模な言語モデルであるChatGPTのプロンプトを生成するPythonベースのツールです。このプロジェクトの目標は、ユーザーが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 >

SQLデータベースの適切なデータベースURLまたは以前に追加した接続の名前に<database_url>を置き換えます。

ChatGPTプロンプトの生成

特定のデータベースのChatGPTプロンプトを生成するには、実行してください。

python sql2gpt.py get_prompt < database_url or name >

SQLデータベースの適切なデータベースURLまたは以前に追加した接続の名前に<database_url>を置き換えます。生成されたプロンプトは、CHATGPTに渡されてコードを取得したり、データベースについて質問したりできます。

ライセンス

このプロジェクトは、MITライセンスの下でライセンスされています。