【SQLクライアントツール】TablePlusの使い方

SQLクライアントツールのTablePlusについて紹介します。

”SQLクライアントツール”とは、SQLをGUI（画面ぽちぽち）で操作できるツールです。

Supabaseであれば、Supabaseの管理画面でクライアントツールが提供されていたり、
ORMのPrismaもクライアントツールを提供しており、
npx prisma studio コマンドでブラウザ上にクライアントツールを立ち上げることができます。

ですが、これらはそれぞれ、毎回管理画面ページにアクセスしなくてはいけなかったり、コマンドを打たないといけなかったりで、結構面倒です。

なので、デスクトップアプリのSQLクライアントツールをPCに1つ入れておくと、
すぐに起動できDBの中身を確認できて便利です。

フリーランスであればさまざまな案件のDBを扱いますが、
1つのデスクトップアプリから複数DBに接続する状態にしておけば、
同じUIで操作できるようになるので、作業効率的にもGOODです。

デスクトップのSQLクライアントツールの使い方はカリキュラムでは登場しないのですが、
エンジニアの人はわりかしみんな使っているので、紹介します。

デスクトップアプリのSQLクライアントツールにも色々種類がありますが、
”TablePlus”は僕の周りでも使っている人が多く、MacもWindowsも対応しているので今回紹介します。

インストール方法

https://tableplus.com/download

こちらから。

SQLの接続方法（SupabaseのPostgreSQL）

インストールしたTablePlusを立ち上げると、以下のような画面になります。

初めは空ですが、複数DBを登録できて、一覧表示されます。

新規登録する際は、左上の「＋」ボタンです。

プラスボタンを押すと、DBの種類を選択する画面になります。（設定項目が異なります。）

SupabaseはPostgreSQLを用いているので、PostgreSQLを選択して、
IDやPASSなど各情報を設定することでも接続できるのですが、

SupabaseはID,PASSも含めた直接接続するURLが発行されているので、「import from URL」を選択します。

URLの入力画面になるので、
環境変数(.env)で設定しているDIRECT_URLを入力して「import」を押すと接続完了です。

使い方

接続したDBを選択すると、以下のような画面になります。

左のサイドバーがテーブル一覧、右の領域に選択したテーブル内のレコード一覧が表示されます。

例えば特定のデータを更新したい場合は、エクセルのようにセルをクリックして編集して、保存することができます。

直接SQLを書いて発行したり、データのCSVエクスポートなども可能です。

実務では、本番環境のDBをメンバーが操作できてしまう訳にはいかないので、
バグの発生時などは、
リードレプリカとって、読み込み専用のコピーDBが用意されていて、そこに接続して対応するのが一般的です。

基本無料で使えます。有料プランもあり、開けるタブの数の制限がなくなるなどありますが、無料で十分だと思います。

接続できるDBは、インターネットを介して到達できるDBのみです。例えばAWSのVPC内に閉じたDBなどには接続できません。

こんな感じで、ブラウザも立ち上げることなく、即座にアプリのDBの中身を確認できるようになりました。