PostgreSQL エキスパート ベストプラクティス

シンプルで実用的、かつ見識のある。プロダクショングレードの PostgreSQL クエリを書くために本当に必要なことだけ。

適用対象

以下の場合にこれらのガイドラインを参照してください:

• データベースマイグレーションやスキーマ変更を書く場合
• PostgreSQL テーブルやカラムを作成・変更する場合
• インデックス、制約、外部キーを追加する場合
• パフォーマンス問題についてデータベーススキーマをレビューする場合
• 既存のデータベース構造をリファクタリングする場合
• クエリパフォーマンスまたはデータベース設計を最適化する場合

ルールカテゴリー (優先度順)

クイックリファレンス

• only-concurrent-indexes - インデックス作成中の書き込みブロックを防ぐため、常に CONCURRENTLY を使用する
• add-index-for-foreign-key - 外部キーのインデックスを作成してクエリパフォーマンスを向上させる
• unique-constraint - 一意制約の作成を並行インデックス + 制約のステップに分割する
• split-foreign-key - 検証なしで外部キーを追加してから、別途検証する
• set-column-not-null - テーブルロックを回避するため、NOT NULL を設定する前にチェック制約を使用する
• only-jsonb - より良いパフォーマンスとインデックス機能のために JSON の代わりに JSONB を使用する
• always-include-columns - 監査可能性のため、すべてのテーブルに id、created_at、updated_at を含める
• limit-non-unique-index - 効率性のため、非一意インデックスを最大 3 カラムに制限する
• index-naming-standards - 一貫したインデックス命名を使用: idx_tablename_columnname
• column-naming-standards - 一貫した snake_case の命名を保ち、外部キーに id サフィックスを使用する

使用方法

詳細な説明とコード例については、個別のルールファイルを参照してください:

rules/only-concurrent-indexes.md
rules/add-index-for-foreign-key.md
rules/unique-constraint.md
rules/split-foreign-key.md
rules/set-column-not-null.md
rules/only-jsonb.md
rules/always-include-columns.md
rules/limit-non-unique-index.md
rules/index-naming-standards.md
rules/column-naming-standards.md

各ルールファイルには以下が含まれます:

• それが重要な理由の簡潔な説明
• インパクトレベルと説明
• 説明付きの間違ったマイグレーションの例
• ベストプラクティス付きの正しいマイグレーションの例
• 追加のコンテキストと参考資料