# 通知設計書 80-クエリレベルチェック

## 概要

本ドキュメントは、SQL Server First Responder Kitのsp_BlitzCacheプロシージャにおいて、クエリレベルのチェックを開始した際に出力される情報通知「クエリレベルチェック」について定義する。

### 本通知の処理概要

本通知は、sp_BlitzCacheストアドプロシージャ内で、収集した実行プラン情報に対するクエリレベルのチェック・分析フェーズが開始されたことをユーザーに通知するための情報メッセージである。

**業務上の目的・背景**：sp_BlitzCacheは、プランキャッシュから収集した実行プランを詳細に分析し、パフォーマンス問題を特定するプロシージャである。クエリレベルチェックでは、各クエリに対して欠落インデックス、メモリ付与情報、コンパイル統計などの問題を検出する。この通知は、詳細分析フェーズが開始されたことを管理者に知らせる。

**通知の送信タイミング**：sp_BlitzCacheプロシージャの分析フェーズにおいて、XMLノード処理と高レベルプラン情報収集の後、クエリレベルのチェックを開始する直前に送信される。具体的にはsp_BlitzCache.sqlの行3145で出力される。

**通知の受信者**：SQL Server Management Studio（SSMS）やその他のクライアントツールでsp_BlitzCacheを実行している管理者・DBA。メッセージタブに情報として表示される。

**通知内容の概要**：「Performing query level checks」という固定メッセージが出力される。これにより、クエリレベルの詳細分析が開始されたことが明確に示される。

**期待されるアクション**：この通知は情報提供目的であり、特別なアクションは不要。このフェーズでは多数のチェック項目が実行されるため、処理が進行中であることを管理者が確認できる。

## 通知種別

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

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（WITH NOWAIT指定により即時出力） |
| 優先度 | 低（情報レベル：severity 0） |
| リトライ | 無し |

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

実行中のセッションのクライアント（SSMSのメッセージタブ等）に対して直接出力される。

## 通知テンプレート

### コンソール出力の場合

| 項目 | 内容 |
|-----|------|
| 出力先 | クライアントのメッセージストリーム |
| メッセージレベル | 0（情報） |
| 状態 | 1 |

### 本文テンプレート

```
Performing query level checks
```

### 添付ファイル

なし

## テンプレート変数

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

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| プロシージャ内部処理 | クエリレベルチェック開始 | XMLノード処理完了後 | 高レベルプラン情報更新後、詳細チェックを開始する時点 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| @SkipAnalysis = 1 | 分析スキップ時は本処理もスキップされる |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[XMLノード処理完了] --> B[高レベルプラン情報更新]
    B --> C["RAISERROR('Performing query level checks',0,1) WITH NOWAIT"]
    C --> D[欠落インデックスカウント取得]
    D --> E[メモリ付与情報取得]
    E --> F[キャッシュプランサイズ取得]
    F --> G[コンパイル統計取得]
    G --> H[コンパイルタイムアウトチェック]
    H --> I[メモリ制限超過チェック]
    I --> J[後続チェックへ]
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| #query_plan | クエリプランXMLの参照 | XMLノード処理で作成 |
| #statements | ステートメント情報の参照 | XMLノード処理で作成 |

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

#### #query_plan
| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| QueryHash | クエリ識別 | ##BlitzCacheProcsとの結合用 |
| SqlHandle | SQL識別 | ##BlitzCacheProcsとの結合用 |
| query_plan | プランXML | XPathでの値抽出用 |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| ##BlitzCacheProcs | UPDATE | クエリレベルチェック結果を格納 |

#### ##BlitzCacheProcsテーブル（更新項目）

| 操作 | 項目（カラム名） | 更新値 | 備考 |
|-----|-----------------|-------|------|
| UPDATE | missing_index_count | 欠落インデックス数 | XPathで抽出 |
| UPDATE | unmatched_index_count | 不一致インデックス数 | XPathで抽出 |
| UPDATE | SerialDesiredMemory | 必要メモリ（シリアル） | XPathで抽出 |
| UPDATE | SerialRequiredMemory | 必須メモリ（シリアル） | XPathで抽出 |
| UPDATE | CachedPlanSize | キャッシュプランサイズ | XPathで抽出 |
| UPDATE | CompileTime | コンパイル時間 | XPathで抽出 |
| UPDATE | CompileCPU | コンパイルCPU | XPathで抽出 |
| UPDATE | CompileMemory | コンパイルメモリ | XPathで抽出 |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 該当なし | 本通知は情報出力のみでエラーは発生しない | - |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

- 本通知は固定の情報メッセージであり、機密情報を含まない
- VIEW SERVER STATE権限を持つユーザーのみがsp_BlitzCacheを実行可能

## 備考

- WITH NOWAIT指定により、バッファリングされずに即時クライアントに送信される
- クエリレベルチェック後には「Performing compile timeout checks」「Performing compile memory limit exceeded checks」などの詳細チェック通知が続く
- XPath式を使用してXMLからプラン属性を抽出する処理が行われる
- @ExpertMode > 0 の場合、追加のチェック項目が実行される

---

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

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

### 推奨読解順序

#### Step 1: XMLネームスペースとXPath式を理解する

クエリレベルチェックで使用されるXPath式を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | sp_BlitzCache.sql | `sp_BlitzCache.sql` | 行3146付近のXMLNAMESPACES宣言を確認 |

**読解のコツ**: XPath式（例：'//p:QueryPlan/p:MissingIndexes/p:MissingIndexGroup'）の意味を理解する。

#### Step 2: クエリレベルチェック処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | sp_BlitzCache.sql | `sp_BlitzCache.sql` | 行3145-3161のクエリレベルチェック処理 |

**主要処理フロー**:
1. **行3145**: `RAISERROR(N'Performing query level checks', 0, 1) WITH NOWAIT;`
2. **行3146-3161**: ##BlitzCacheProcsの更新（XPathで値抽出）
   - missing_index_count: 欠落インデックス数
   - unmatched_index_count: 不一致インデックス数
   - SerialDesiredMemory: 必要メモリ
   - CachedPlanSize: プランサイズ
   - CompileTime/CPU/Memory: コンパイル統計

#### Step 3: 後続のチェック処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | sp_BlitzCache.sql | `sp_BlitzCache.sql` | 行3164-3230付近の各種チェック |

**主要処理フロー**:
- **行3164**: コンパイルタイムアウトチェック
- **行3175**: メモリ制限超過チェック
- **行3188**: パラメータ化されていないクエリチェック（@ExpertMode > 0時）
- **行3212**: インデックスDMLチェック（@ExpertMode > 0時）

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

```
sp_BlitzCache（エントリーポイント）
    │
    ├─ 実行プラン収集
    │
    ├─ XMLノード処理
    │
    ├─ 高レベルプラン情報更新
    │
    ├─ RAISERROR('Performing query level checks') ← 本通知
    │
    └─ クエリレベルチェック
           │
           ├─ 欠落インデックスカウント
           ├─ メモリ付与情報
           ├─ キャッシュプランサイズ
           ├─ コンパイル統計
           │
           └─ 詳細チェック
                  ├─ compile_timeout
                  ├─ compile_memory_limit_exceeded
                  ├─ unparameterized_query（@ExpertMode > 0）
                  └─ index_dml（@ExpertMode > 0）
```

### データフロー図

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

#query_plan                   ───▶ クエリレベルチェック     ───▶ クライアントメッセージ
  │                                  │                                 「Performing query level checks」
  │                                  │
  └─ query_plan XML           ───▶ XPath値抽出             ───▶ ##BlitzCacheProcs更新
       │                              │
       ├─ MissingIndexes             └─ missing_index_count
       ├─ MemoryGrantInfo            └─ SerialDesiredMemory
       └─ QueryPlan属性              └─ CachedPlanSize, CompileTime等
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| sp_BlitzCache.sql | `sp_BlitzCache.sql` | ソース | メインプロシージャ。クエリレベルチェック通知を出力（行3145） |
| Install-All-Scripts.sql | `Install-All-Scripts.sql` | インストール | 全スクリプトを含むインストールファイル（行16296） |
| Install-Azure.sql | `Install-Azure.sql` | インストール | Azure向けインストールファイル（行4031） |
| Deprecated/sp_BlitzQueryStore.sql | `Deprecated/sp_BlitzQueryStore.sql` | 旧バージョン | Query Store版（行3812） |
