driver不要のRust製PostgreSQL用爆速TUIツール、sabiqlを作った
はじめに
セットアップ不要、最小限の依存で使える爆速Rust製TUIツール sabiql を作りました。
公開後、ratatuiメンテナのorhunにも紹介いただき、awesome-ratatuiにも掲載されています!
それ以来、issueでいくつか要望をいただいており順次対応中です。
なぜ作った
- セットアップいらずですぐ使えるものがほしかった
driver入れる手順とかが個人的に面倒くさくて。PostgreSQLユーザーにはだいたいpsqlが入っているでしょうという事で、psqlだけで済ませたかった - 自分好みのUI/UXにしたかった
わりとこれが一番の理由かもしれません- neovimで言うなら、neo-treeのようなサイドバー常駐型ではなく、oil.nvimのような必要なときだけ視界の中央に現れて、視線を動かさず済むミニマルな操作感のTUIが欲しかった
- かつ、なるべく軽量・爆速なやつがほしかった
- ER図が見たかった
DBeaver, DataGrip等では出せますが、TUIツールで出せるものは現状ありませんでした
そしてこれらをTerminalから離れずにやりたかったんです。インフラ作業やSSH先での作業をCLIでこなしている人なら共感してもらえると思います。GUIツールを別途開くのが面倒なんですよね。
どんなUI/UXにしたか、思想
vim-vinegarの作者Drew Neilはこう言っています。
"Split windows and the project drawer go together like oil and vinegar. I don't mean to say that you can combine them to create a delicious salad dressing. I mean that they don't mix well!"
— Drew Neil, Oil and vinegar – split windows and the project drawer
oil.nvimはこの思想を受け継いで、ファイル操作を普通のバッファとして扱うことで、サイドバーが視界を占有し続ける問題を解消しました。
このプロダクトでも似たような感覚で作ったつもりです。
SQL・ER図・クエリ結果はそれぞれ独立したUIとして呼び出し、用が済めば即座に元の画面へ戻る。結果をじっくり確認したいときは全画面モードに切り替えることも可能です。マウスも別ウィンドウも不要で、コンテキストスイッチを最小限に保てるような操作感になるよう改善し続けています。
Feature
何ができるか紹介します。
1. Connection

初回起動時にコネクション情報を入力。以降は保持されるので再入力不要。設定の編集も可能。
(つい先日要望あって、pg_service.conf経由でのログインにも対応しました)

接続エラー時はエラー内容をyankできるので、そのまま生成AIに貼り付けてデバッグも可能。
2. Inspector Pane

接続するとテーブル一覧(Explorer)、カラム詳細(Inspector)が表示されます。
このInspectorペインには7タブ用意していて、だいたいのテーブルのメタ情報は確認できます。
| タブ | 内容 |
|---|---|
| Info | オーナー・コメント・推定行数・スキーマ |
| Cols | カラム名・型・NULL可否・PK・デフォルト値・コメント |
| Idx | インデックス名・対象カラム・種別(btree/hash/gin等)・Unique有無 |
| FK | 外部キー名・参照先テーブル・カラム |
| RLS | RLS有効/無効・ポリシー名・コマンド・PERMISSIVE/RESTRICTIVE |
| Trig | トリガー名・タイミング・イベント・関数名 |
| DDL | 自動生成されたCREATE TABLE文 |
たとえばこのテーブルにRLS制御かかってるだか、ownerが誰だからこのroleはRLSがbypassされてしまうとか...そんなことを即座に理解できます。
DDLはcopy/yankできるようにしています。
3. Inline Edit & Row Delete

インライン編集をサポートしており、実行時にプレビュー表示されるので意図した通りの変更か確認できます。
WHEREなし・行を特定できないケースは実行前にブロックされるので、意図しない全件更新・削除は防げます。
dd→:wでvimライクな行削除も可能(プレビュー確認あり)。
4. SQL Modal

sでSQLモーダル起動できます。
pgcliのようにテーブル名・カラム名・キーワードの自動補完つきなので、うろ覚えでもなんとかなります。
ちなみに補完のために全テーブル情報を事前にフェッチする必要があって、実装初期は2-3秒ほどCPU負荷が上がる状態になってました。
パフォーマンス面の工夫は後述の技術セクションで詳しく書きます。
5. ER Diagram
この手のTUIツールでは珍しい機能ではないでしょうか?

eでER図を生成しブラウザで表示します。 特定テーブルだけ指定したFocused ER図も可能です。
ER図生成には全テーブルの詳細情報が必要で、こちらもパフォーマンス面で工夫しています。
詳しくは後述します。
6. Vim-like操作 & コマンドパレット
j/k、g/G、fでフォーカスモードなど。Ctrl+Kでコマンドパレット。?でキー一覧です。
7. ターミナルテーマをそのまま反映
Theme、特に強制してません。基本的にはターミナルテーマに追従します。
透過が好きな人はそのまま反映されます。うれC。
ターミナルの見た目にこだわる人にはたまらんはずです。
技術的な話
セットアップ不要という方針を実現するために、libpqやネイティブドライバの代わりにpsqlをサブプロセスとして呼び出す設計を選びました。
ただそのトレードオフとしてクエリごとにpsqlがspawnされる状況になってます。フェッチが多いほどspawnコストがかかってくるのですが、以下の工夫をしました。
SQL補完のプリフェッチ最適化
補完のために全テーブル情報を事前にフェッチする必要があって、最初は3-5秒ほどCPU負荷が上がる状態になってました。
最初の実装では1テーブルあたり6クエリを個別実行していたので、538テーブルなら3228回のpsql spawnが走る計算になってました。
補完エンジンが実際に使うカラム+FKだけを1クエリで取得する軽量クエリを用意し、Idx/RLSなどの不要なフェッチを丸ごと除外。
結果spawn数が1/6になり、CPUスパイクが3-5秒→0.1秒未満まで落ちました。(538テーブルのDBで検証済み)
キャッシュ戦略
Explorer・SQL補完・ER図生成とあちこちでフェッチが走るので、大規模DBではキャッシュ戦略も重要です。
取得コストとアクセスパターンに着目して、2層に分けました。
Tier1はDBのテーブル一覧・スキーマ情報を持つTTLキャッシュ。ExplorerのテーブルリストやSQL補完の初期化で使われ、頻繁には変わらない情報なので一定時間そのまま使い回します。
Tier2はテーブルごとのカラム・FKをLRUキャッシュで保持。SQL補完エンジンとER図生成で共有しているので、補完でキャッシュ済みのテーブルはER図生成で再取得不要です。
ただしER図生成のみTier1をあえてbypassして毎回直接フェッチしています。「ER図は常に最新のテーブル構造を見せる」という一貫性を維持したく。
再生成時はpg_catalogのMD5署名を使って差分を検知するようにしていて、変更があったテーブルのみを対象にTier2を更新するので、ALTER TABLE直後でも常に最新の状態が保たれます。
インストール
# macOS / Linux
brew install riii111/sabiql/sabiql
# Cargo (crates.io)
cargo install sabiql
# Arch Linux (AUR)
paru -S sabiql # or yay -S sabiql
# FreeBSD (ports)
cd /usr/ports/databases/sabiql/ && make install clean
# Install script
curl -fsSL https://raw.githubusercontent.com/riii111/sabiql/main/install.sh | sh
sabiqlで起動。初回にコネクション情報を入力すれば次回以降は自動接続。?でヘルプ。
今後の展望
- Explainで分析
- CASCADE削除の視覚化
- クエリ履歴の保持
- Cloud SQL/AlloyDB接続対応
などなど色々やりたいことが盛り沢山です。いずれMySQLもやるかもです。
まとめ
自分がずっと使い続ける予定なので頻繁にメンテします。
ぜひ一度試してみてください!!フィードバックや要望、バグ報告はGitHub Issuesで大歓迎です。
⭐ https://github.com/riii111/sabiql
Discussion