まだ PostgreSQL の開発で疲弊してるの？

Last updated at 2022-06-06Posted at 2022-06-06

この記事は、勉強会で発表したスライドを Qiita Engineer Festa 向けに書き直したものです。
PL/pgSQL Language Server を開発しました。

PostgreSQL の開発がつらい

弊社では RDS として PostgreSQL を採用しており、
ロジック部分を PL/pgSQL の Stored Function / Procedure を用いて書くことがあります。

しかし、これがつらい

まるでメモ帳で開発をしているかのようだ...(著者の感想)

TypeScript や Rust のような補完や構文チェックが欲しい～～～～ということで
VSCode 用に PL/pgSQL の Language Server を作りました

PL/pgSQL Language Server

できたのがこれです。

できること一覧

テーブル名などの補完
定義への移動
シンボルへの移動
定義のホバー表示
構文チェック
静的解析チェック（plpgsql_check を使っている時だけ）
「現在のファイルを実行」コマンド
マルチワークスペースの対応

各機能の現在の対応表は下記です。

	補完	定義へ移動	ホバー表示
DOMAIN	✔️	✔️	✔️
FUNCTION	✔️	✔️	✔️
INDEX	-	✔️	✔️
MATERIALIZED VIEW	✔️	✔️	✔️
PROCEDURE	✔️	✔️	✔️
TABLE	✔️	✔️	✔️
TRIGGER	-	✔️	✔️
TYPE	✔️	✔️	✔️
VIEW	✔️	✔️	✔️

使い方

ワークスペースで設定するだけ

VSCode のワークスペース毎に接続したいデータベースを設定します。

vscode/settings.json

{
  "plpgsqlLanguageServer.database": "データベース名",
  "plpgsqlLanguageServer.user": "ユーザ名",
  "plpgsqlLanguageServer.password": "パスワード",
  "plpgsqlLanguageServer.definitionFiles": [
    // glob をサポート。
    "**/*.sql",
    "**/*.psql",
    "**/*.pgsql"
  ],
  // Language Server が対応するファイルの拡張子はデフォルトで ['*.pgsql', '*.psql'] です。
  // （ SQLite など他の RDS と競合させないためです。）
  // '*.sql' のファイルも対応させたい場合は、下記の設定を追加してください。
  "files.associations": {
    "*.sql": "postgres"
  }
}