# 通知設計書 81-警告チェック

## 概要

本ドキュメントは、SQL Server First Responder Kitのsp_BlitzCache.sqlにおける「警告チェック」通知の設計を定義する。この通知は、クエリプランキャッシュの分析中にプラン警告をチェックする処理段階を示す情報メッセージである。

### 本通知の処理概要

この通知は、sp_BlitzCacheストアドプロシージャがキャッシュされた実行プランを分析する際に、XMLクエリプラン内に存在するプラン警告（Warnings要素）を検出するチェック処理の開始を示す。

**業務上の目的・背景**：SQL Serverの実行プランには、クエリオプティマイザが生成したさまざまな警告情報が含まれる。これらの警告はパフォーマンス問題の兆候を示す重要な指標であり、DBAやデベロッパーがクエリの最適化ポイントを特定するために不可欠である。プラン警告には、統計の欠落、型の不一致による暗黙的変換、結合述語の欠落などが含まれ、これらを早期に検出することでパフォーマンス劣化を防止できる。

**通知の送信タイミング**：sp_BlitzCacheプロシージャの実行中、クエリプランコストの設定が完了し、プラン警告チェック処理が開始される直前のタイミングで送信される。具体的には、XMLクエリプランの`/p:QueryPlan/p:Warnings`ノードの存在を確認するUPDATE文の実行直前である。

**通知の受信者**：この通知はRAISERROR関数によりSQL Server Management Studio（SSMS）のメッセージウィンドウ、またはsqlcmdなどのコマンドラインツールの標準出力に表示される。主な受信者は、sp_BlitzCacheを実行しているDBA、データベース開発者、システム管理者である。

**通知内容の概要**：「Checking for plan warnings」という英語メッセージが表示され、現在プラン警告のチェック処理を実行中であることを示す。これにより、長時間実行される分析処理の進捗状況を把握できる。

**期待されるアクション**：通知の受信者は、処理が正常に進行していることを確認し、処理完了を待つ。異常に長時間この段階で停止している場合は、クエリプランキャッシュのサイズや対象クエリ数を確認し、必要に応じて@Topパラメータで分析対象を絞り込む。

## 通知種別

コンソール出力（RAISERROR WITH NOWAIT）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（WITH NOWAITオプションにより即座に出力） |
| 優先度 | 低（情報レベル、重大度0） |
| リトライ | なし（単発の情報メッセージ） |

### 送信先決定ロジック

sp_BlitzCacheを実行しているセッションのクライアント接続に対して直接出力される。送信先の動的な決定ロジックは存在せず、実行元のセッションに対して常に通知される。

## 通知テンプレート

### メール通知の場合

該当なし（コンソール出力のみ）

### 本文テンプレート

```
Checking for plan warnings
```

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| なし | 固定メッセージのため変数なし | - | - |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| プロシージャ実行 | sp_BlitzCache内のチェック処理開始 | 常に送信（条件なし） | プラン警告チェック処理の開始時に必ず通知 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| なし | このメッセージは常に出力される |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[QueryPlanCost NULL更新完了] --> B[RAISERROR実行]
    B --> C[メッセージ即時出力]
    C --> D[plan_warningsフラグ更新処理]
    D --> E[XMLクエリプラン解析]
    E --> F[Warnings要素存在チェック]
    F --> G[##BlitzCacheProcs更新]
    G --> H[次のチェック処理へ]
```

## データベース参照・更新仕様

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| ##BlitzCacheProcs | プランキャッシュ分析結果の格納 | グローバル一時テーブル |
| #query_plan | クエリプランXMLの一時格納 | ローカル一時テーブル |

### テーブル別参照項目詳細

#### ##BlitzCacheProcs

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| SqlHandle | クエリプランの結合キー | WHERE SPID = @@SPID |
| plan_warnings | 警告フラグの更新対象 | SET句で1に更新 |

#### #query_plan

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| SqlHandle | 結合キー | ##BlitzCacheProcsとの結合 |
| query_plan | XMLプランの解析 | exist()関数でWarnings要素確認 |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| ##BlitzCacheProcs | UPDATE | plan_warningsカラムを1に設定 |

#### ##BlitzCacheProcs更新

| 操作 | 項目（カラム名） | 更新値 | 備考 |
|-----|-----------------|-------|------|
| UPDATE | plan_warnings | 1 | 警告が存在する場合のみ |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| XMLパースエラー | 不正なXMLフォーマット | エラーは発生しにくいが、存在チェックのみのため影響なし |
| メモリ不足 | 大量のプラン処理時 | @Topパラメータで対象を制限 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし |
| リトライ間隔 | - |
| リトライ対象エラー | - |

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 1分あたり上限 | 制限なし |
| 1日あたり上限 | 制限なし |

### 配信時間帯

制限なし（sp_BlitzCache実行時に即座に出力）

## セキュリティ考慮事項

- 通知内容に機密情報は含まれない
- VIEW SERVER STATE権限が必要（sp_BlitzCache実行の前提条件）

## 備考

- この通知はsp_BlitzCacheの進捗表示の一部であり、長時間実行時のユーザーへのフィードバックとして機能する
- WITH NOWAITオプションにより、バッファリングなしで即座にクライアントに送信される
- 重大度0は情報メッセージを意味し、エラーではない

---

## コードリーディングガイド

本通知を理解するために参照すべきファイルと、推奨する読み解き順序を以下に示す。

### 推奨読解順序

#### Step 1: データ構造を理解する

まず、プロシージャで使用される一時テーブルの構造を把握する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | sp_BlitzCache.sql | `sp_BlitzCache.sql` | ##BlitzCacheProcsテーブルのplan_warningsカラム定義を確認 |

**読解のコツ**: T-SQLのグローバル一時テーブル（##で始まる）はセッションをまたいで共有可能だが、この実装ではSPIDカラムで現在のセッションのデータのみをフィルタリングしている。

#### Step 2: エントリーポイントを理解する

処理の起点となるストアドプロシージャの構造を把握する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | sp_BlitzCache.sql | `sp_BlitzCache.sql` | プロシージャの全体構造とパラメータを確認 |

**主要処理フロー**:
1. **行3378**: RAISERROR(N'Checking for plan warnings', 0, 1) WITH NOWAITでメッセージ出力
2. **行3379-3386**: XMLNAMESPACESを使用したプラン警告チェックのUPDATE文実行

#### Step 3: XMLプラン解析処理を理解する

警告チェックの実際のロジックを把握する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | sp_BlitzCache.sql | `sp_BlitzCache.sql` | WITH XMLNAMESPACES句とexist()関数の使用方法 |

**主要処理フロー**:
- **行3379**: XMLネームスペースの定義（showplanスキーマ）
- **行3385**: query_plan.exist('/p:QueryPlan/p:Warnings')でWarnings要素の存在確認

### プログラム呼び出し階層図

```
sp_BlitzCache
    |
    +-- [前処理] QueryPlanCost NULL値の更新
    |
    +-- RAISERROR('Checking for plan warnings')  <-- 本通知
    |       |
    |       +-- UPDATE ##BlitzCacheProcs SET plan_warnings = 1
    |               |
    |               +-- #query_plan との JOIN
    |               |
    |               +-- query_plan.exist() によるXML解析
    |
    +-- [後続処理] Checking for implicit conversion
```

### データフロー図

```
[入力]                      [処理]                         [出力]

#query_plan.query_plan  --> XMLネームスペース解析      --> ##BlitzCacheProcs.plan_warnings
(XMLクエリプラン)           exist('/p:QueryPlan/p:Warnings')    (1 = 警告あり)
                                    |
                                    v
                           コンソール出力 <-- RAISERROR
                           "Checking for plan warnings"
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| sp_BlitzCache.sql | `sp_BlitzCache.sql` | ソース | プラン警告チェック処理を含むメインストアドプロシージャ |
