Skip to content

SQL のレビューと説明 ​

このガイドでは、DDLBuilder の**「マスターレビュー」機能を用いたエキスパートレベルの DDL 品質診断と、「SQL 解説」**機能による複雑な構文の即時解析手順を解説します。

概要 ​

DBA の承認申請やリリース前レビューの前に潜在的なパフォーマンス課題や規約違反を自己診断し、見慣れない方言構文や複雑な句の動作を迅速に把握できます。


主な操作手順 ​

1. マスターレビュー(アーキテクチャ品質診断) ​

  1. テーブルにフィールドが設定され、右側に有効な DDL が生成されていることを確認します。
  2. 出力エリア上部の**「マスターレビュー」**ボタンをクリックします。
  3. 多次元スコアリングと診断レポートの確認:
    • 命名規則、データ型選定、インデックス効率、整合性制約、拡張性、性能リスクの各観点から包括的に診断し、総合スコア(1〜10点)を出力します。
    • 問題を重要度(高リスク、改善提案、ベストプラクティス)ごとに分類し、具体的な修正理由を提示します。
  4. 提案のワンクリック適用: 構造的な改善提案(例: 複合インデックスの追加、型の最適化)は、カード上の**「適用」**ボタンを押すだけでフィールドやインデックス設定へ自動反映されます。
  5. レビュー履歴の追跡: パネル上部の履歴アイコンから、過去の診断履歴やスコアの推移をいつでも確認できます。

2. 選択した SQL の解説(Explain Selected SQL) ​

  1. 右側の SQL エディター内で、詳細を確認したい任意の SQL 構文や句(特殊なインデックスオプション、パーティション定義、ストレージ設定など)をマウスで選択(ハイライト)します。
  2. 選択箇所の横に**「選択範囲を解説」**ポップアップが表示されます。
  3. クリックすると、AI がその構文の実行セマンティクス、対象データベースでの動作特性、業務上の意図を即座に解説します。

完了のチェックリスト ​

  • [ ] マスターレビューを実行し、高リスクな警告項目に対処済みである。
  • [ ] 採用した改善提案がテーブル設定に反映され、右側の DDL が更新されている。
  • [ ] 複雑な SQL 構文の意味を把握し、チーム内レビューで説明できる状態になっている。

注意事項 ​

業務要件に基づく確認

マスターレビューの提案は一般的なベストプラクティスに基づいています。意図的な非正規化設計など、独自の業務ルールがある場合は要件に照らし合わせて採否を判断してください。

  • 有効な DDL の必須性: テーブル名とフィールドが入力され、右側に DDL が出力されている状態でのみレビューを実行できます。
  • 選択範囲の正確性: 「選択範囲を解説」を使用する際は、構文エラーを防ぐため完全な句や文単位でハイライトしてください。