😸

生成AI ✖️ SQL 🟰 ⚡️ Supabase SQL Editor

2023/12/10に公開

PostgreSQL

SQL

supabase

tech

アドベントカレンダーのネタ探ししていたら、supabase の SQL Editor が AI 搭載されていて、面白そうだったので、もう・・・・記事にしてみます！

僭越ながら以下の advent カレンダーに登録させてもらいました！(supabase もっと盛り上がれ・・・!🙏)

Supabase SQL Editor: 生成AI搭載の SQL エディタ

Supabase あまり詳しくないですが、たまたま見つけた以下の記事によると、今年の8月ごろにいろいろと新しい機能が出ていたみたいです。

新機能を引用すると：

Supabase AI in the SQL Editor: inline AI, always ready to help

Schema Visualizer: — see all your table schemas visually.

Role Management: — fine-grained access to table data

Shared SQL Snippets: — share your snippets with the team

Database Migration UI: — your database, with receipts

Wrappers UI: — easily query foreign data

なかでも特にAIが入っている SQL Editor が気になる！
SQLを考えるのしんどいときあるから、AIがSQL書いてほしい・・・

あとで触れますが、Schema Visualizer もなかなか便利そうです。

ということで、Supabase のプロジェクトを作成して(無料)、AI搭載のSQL editor と Schema Visualizer の使い勝手を確認してみました。

1. アカウント作成、プロジェクト作成

まず、アカウントなければアカウント作成しますが、メアドを登録するだけで簡単にアカウント作れたかと思います。

アカウント作成(無料)し、supabase にログインすると、以下のような画面が出てくるので、
+ New Project をクリックしてプロジェクトを作成(無料)します。

プロジェクト作成時、Name は適当なプロジェクト名をつけます。
ここで、パスワードを設定しますが、後ほど postgresql への接続で必要なので、パスワードはちゃんと覚えておきます。
Region はおそらく日本がいいでしょう。

以上で、プロジェクト作成が終わり、supabase の postgresql の DB が使えるようになります。

試しに、supabase でホストされている postgresql にローカルPCのターミナルから接続してみます。

ログインに必要なコマンドは便利なことに、supabase の管理画面からコピペできます。
⚙(歯車)マークをクリックして、左のペインから Database をクリックすると以下の画面が開き、Connection string のところに postgresql にログインするための psql コマンドが用意されています。それをコピー。

Connection string にプログラミング別の接続情報もありますが、とりあえず PSQL を使います

ローカルのターミナルに、psql がある方は、コピーしたコマンドをそのまま実行できますが、
自分の端末には postgresql インストールしていないので、docker コンテナで実行します。
パスワード聞かれるので、supabase プロジェクト作成時に設定したパスワードを入力します。

❯ docker run \
	-it \
	--name psql \
	--rm \
	postgres:16.1 psql -h xxxxxxxxxxxxxxxxxxx.supabase.co -p 5432 -d postgres -U postgres
Password for user postgres:

docker コマンドのスイッチは、特別なものはないですが、
コンテナの引数には、supabase の管理画面からコピーしたコマンドを使います。(ユーザー名や、DBの指定は変更不要)

パスワードを入力して、psql のプロンプトが出てきたら、疎通は成功です。

postgres=>

2. ダンプファイルから supabase の DB にサンプルのテーブルを作成する

SQL Editor で「〇〇でXXなレコードを検索して！」みたいな指示をAIに出したいんですが、
そもそものテーブルとレコードが無いと始められないので、サンプルデータが必要でした。

そして、postgresql だとレンタルDVDをテーマにしたサンプルDBのダンプファイルがネットからダウンロードできた記憶が・・・（昔postgresql調べたときの記憶)

ぐぐってみると以下のサイトで、postgresql のサンプルDBのダンプがダウンロードできました。
Download DVD Rental Sample Database のリンククリックしたらダウンロードできます。

ダウンロードしたファイルが zip された tar ファイルなので、まずは解凍

unzip dvdrental.zip

次に、pg_restore を使って、supabase の DB にダンプファイルを読み込ませます。
pg_restore は postgres の docker イメージに含まれているので、それを使います。

docker run \
	-it \
	--workdir /psql \
	-v $(pwd):/psql \
	--name psql \
	--rm \
	postgres:16.1 pg_restore -h db.xxxxxxxxxxxxxxxx.supabase.co -p 5432 -d postgres -U postgres dvdrental.tar

docker コマンドのスイッチは、ダウンロードしたダンプファイルをコンテナにバインドマウントしています。→ --v $(pwd):/psql

肝心の ps_restore コマンドの引数は前述の疎通確認時に使った psql コマンドの引数とほぼ同じですが、改めて確認すると、、、、

-h: supabase の postgresql サーバーのホスト名
-p: ポート番号、デフォルトを指定
-d: DBを指定(はじめからある postgres の db を指定)
-U: ユーザー名、postgres 固定
引数は、ダウンロードし、解凍したダンプファイル dvdrental.tar

このコマンドでダンプファイルを読み込ませるのは数秒かかるかと思います。(ネットワーク状況によってはもっと・・？)

終わったら、psql で supabase 上の postgresql に接続して確認してみます。

接続のコマンド:

❯ docker run \
	-it \
	--name psql \
	--rm \
	postgres:16.1 psql -h xxxxxxxxxxxxxxxxxxx.supabase.co -p 5432 -d postgres -U postgres

接続後、以下のコマンドを実行
postgres の名前がついた db があります。

postgres=> \l
                                                      List of databases
   Name    |  Owner   | Encoding | Locale Provider | Collate |  Ctype  | ICU Locale | ICU Rules |      Access privileges
-----------+----------+----------+-----------------+---------+---------+------------+-----------+-----------------------------
 postgres  | postgres | UTF8     | libc            | C.UTF-8 | C.UTF-8 |            |           | =Tc/postgres               +
           |          |          |                 |         |         |            |           | postgres=CTc/postgres      +
           |          |          |                 |         |         |            |           | dashboard_user=CTc/postgres
 template0 | postgres | UTF8     | libc            | C.UTF-8 | C.UTF-8 |            |           | =c/postgres                +
           |          |          |                 |         |         |            |           | postgres=CTc/postgres
 template1 | postgres | UTF8     | libc            | C.UTF-8 | C.UTF-8 |            |           | =c/postgres                +
           |          |          |                 |         |         |            |           | postgres=CTc/postgres
(3 rows)

次のコマンドでその db に接続します。

postgres=> \c postgres

postgresql に入れたダンプファイルに actor テーブルが含まれているので、試しにそれを select してみます

dvdrental=> select * from actor;
 actor_id | first_name  |  last_name   |      last_update
----------+-------------+--------------+------------------------
        1 | Penelope    | Guiness      | 2013-05-26 14:47:57.62
        2 | Nick        | Wahlberg     | 2013-05-26 14:47:57.62
        3 | Ed          | Chase        | 2013-05-26 14:47:57.62
        4 | Jennifer    | Davis        | 2013-05-26 14:47:57.62
        5 | Johnny      | Lollobrigida | 2013-05-26 14:47:57.62

～～～～～～～～～～～～～～～～～～～～～～～～～～～～～～～～～～
                    省略
～～～～～～～～～～～～～～～～～～～～～～～～～～～～～～～～～～

ダンプファイルが postgresql に入っていることが確認できました。
actor テーブル以外にも様々なテーブルが入っています。

この状態で更に、 Schema Visualizer でどんなテーブルがどんなリレーションで存在しているのか確認することもできます。(つまり ER 図)

データを投入しただけで、勝手にER図まで生成してくれるなんて便利ですね！
全体像がよくわかります。

3. SQL Editor を使い始める前に少し設定が必要

SQL Editor で最初から AI が使えるのですが、プロジェクトに含まれるテーブルをAIのコンテキストに入れるために、設定が必要です。これをしないと、AIに指示を出しても、既存のプロジェクトのテーブルを考慮しないジェネリックなSQLしか生成してくれません。

この設定に関して、ドキュメントで説明を見つけられなかったですが、することは簡単で、以下のスクショのように、 SQL Editor の画面右上にある、⚙歯車マークをクリックして、 Include anonymous database metadata in AI queries を有効にします。
こうすることで、テーブル名やカラム、カラムの型の情報などが、AI に metadata として送信されるようになります。

anonymouse(匿名) と書いてあるところからわかるように、テーブル名とかのメタデータはAIに送られますが、レコードとかは送られないようなので、一応センシティブな情報が外に漏れ出さないように配慮されているようです。(テーブル名やカラム名にガッツリ個人情報や秘密の情報が含まれていたらおしまいですが、そんなことはあまり無いでしょう。)