コードレビューとデバッグのための SQL 整形のコツ

可読性はレビュー道具であり保証ではない

整形されたクエリも、あくまでクエリです。整形の役割は、句を分け、入れ子を見えるようにし、join や変更操作を見つけやすくすることです。その文が対象データベース方言で有効か、そもそも実行すべきかは、別途判断する必要があります。

整形で危険箇所を切り出す

最も重要なレビュー対象は、たいてい範囲とデータ整合性に影響する箇所です。join、where 句、grouping、limit、update 対象、delete filter などです。クエリが読みやすくなれば、チームは密な 1 行文を信じるのではなく、それらの行を意図的に確認できます。

• スタイルの好みを見る前に、join と filter を確認します。
• 書き込み文は、読み取り専用の整形例より高リスクとして扱います。
• ベンダー固有構文を含むクエリでは、対象データベース方言を常に意識します。

A practical browser workflow

クエリを貼り付けて整形し、作用範囲を定義する句を確認します。その後、チームが意図に合意してから、読みやすい結果をコードレビュー、migration note、query console にコピーします。整形はレビューを可能にする手順であり、実行を承認する手順ではありません。