# 通知設計書 79-XMLノード処理開始

## 概要

本ドキュメントは、SQL Server First Responder Kitのsp_BlitzCacheプロシージャにおいて、XMLノード処理を開始した際に出力される情報通知「XMLノード処理開始」について定義する。

### 本通知の処理概要

本通知は、sp_BlitzCacheストアドプロシージャ内で、収集した実行プランXMLのノード処理フェーズが開始されたことをユーザーに通知するための情報メッセージである。

**業務上の目的・背景**：sp_BlitzCacheは、プランキャッシュから収集した実行プランXMLを詳細に分析する。実行プランはXML形式で格納されており、各種オペレータ（RelOp）やステートメント情報を抽出するためにXMLノード処理が必要となる。この通知は、XML解析フェーズが開始されたことを管理者に知らせる。大規模なプランを持つ環境では、このフェーズに時間がかかる可能性がある。

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

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

**通知内容の概要**：「Begin XML nodes processing」という固定メッセージが出力される。これにより、実行プランXMLの詳細解析が開始されたことが明確に示される。

**期待されるアクション**：この通知は情報提供目的であり、特別なアクションは不要。複雑な実行プランを多数持つ環境では、このフェーズに時間がかかる可能性があるため、管理者は処理が進行中であることを確認できる。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

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

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

### 本文テンプレート

```
Begin XML nodes processing
```

### 添付ファイル

なし

## テンプレート変数

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

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| プロシージャ内部処理 | XMLノード処理開始 | 実行プラン収集完了後 | XMLノードからステートメント・オペレータ情報を抽出する処理の開始時 |

### 送信抑止条件

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

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[実行プラン収集完了] --> B[プラン情報集約]
    B --> C["RAISERROR('Begin XML nodes processing',0,1) WITH NOWAIT"]
    C --> D[#statements一時テーブル作成]
    D --> E[StmtSimpleノード抽出]
    E --> F[StmtCursorノード抽出]
    F --> G[#query_plan一時テーブル作成]
    G --> H[QueryPlanノード抽出]
    H --> I[#relop一時テーブル作成]
    I --> J[RelOpノード抽出]
    J --> K[高レベルプラン情報更新]
    K --> L[クエリレベルチェックへ]
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| ##BlitzCacheProcs | 実行プランXMLの取得 | QueryPlanカラム |

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

#### ##BlitzCacheProcs
| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| QueryHash | クエリ識別 | - |
| SqlHandle | SQL識別 | - |
| PlanHandle | プラン識別 | - |
| QueryPlan | 実行プランXML | XMLノード処理対象 |
| SPID | セッション識別 | @@SPID と一致 |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| #statements | CREATE/INSERT | ステートメントノードを格納 |
| #query_plan | CREATE/INSERT | クエリプランノードを格納 |
| #relop | CREATE/INSERT | RelOpノードを格納 |

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

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

## 備考

- WITH NOWAIT指定により、バッファリングされずに即時クライアントに送信される
- XMLノード処理にはXMLNAMESPACES（'http://schemas.microsoft.com/sqlserver/2004/07/showplan' AS p）が使用される
- 処理後には「Gathering high level plan information」などの後続処理通知が出力される
- XMLノード処理はCPU集約的な処理であり、大量のプランがある場合は時間がかかる

---

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

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

### 推奨読解順序

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

実行プランXMLの構造とネームスペースを理解する。

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

**読解のコツ**: SQL Server実行プランのXMLスキーマ（http://schemas.microsoft.com/sqlserver/2004/07/showplan）を理解する。

#### Step 2: XMLノード抽出処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | sp_BlitzCache.sql | `sp_BlitzCache.sql` | 行3073-3114のXMLノード処理 |

**主要処理フロー**:
1. **行3073**: `RAISERROR(N'Begin XML nodes processing', 0, 1) WITH NOWAIT;`
2. **行3074-3084**: #statementsテーブル作成（StmtSimpleノード抽出）
3. **行3086-3096**: StmtCursorノード追加
4. **行3098-3105**: #query_planテーブル作成（QueryPlanノード抽出）
5. **行3107-3114**: #relopテーブル作成（RelOpノード抽出）

#### Step 3: ノードデータの活用を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | sp_BlitzCache.sql | `sp_BlitzCache.sql` | 行3117-3142の高レベルプラン情報更新 |

**主要処理フロー**:
- **行3117**: 高レベルプラン情報の収集開始
- **行3118-3142**: ##BlitzCacheProcsの更新（NumberOfDistinctPlans等）

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

```
sp_BlitzCache（エントリーポイント）
    │
    ├─ 実行プラン収集
    │
    ├─ ストアドプロシージャ情報集約
    │
    ├─ RAISERROR('Begin XML nodes processing') ← 本通知
    │
    ├─ XMLノード処理
    │      │
    │      ├─ #statements作成
    │      │      └─ QueryPlan.nodes('//p:StmtSimple')
    │      │
    │      ├─ StmtCursor追加
    │      │      └─ QueryPlan.nodes('//p:StmtCursor')
    │      │
    │      ├─ #query_plan作成
    │      │      └─ statement.nodes('//p:QueryPlan')
    │      │
    │      └─ #relop作成
    │             └─ query_plan.nodes('//p:RelOp')
    │
    └─ クエリレベルチェック
```

### データフロー図

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

##BlitzCacheProcs.QueryPlan   ───▶ XMLノード処理            ───▶ クライアントメッセージ
(XML形式)                            │                                 「Begin XML nodes processing」
                                      │
                                      ├─ StmtSimpleノード抽出  ───▶ #statements
                                      │
                                      ├─ QueryPlanノード抽出   ───▶ #query_plan
                                      │
                                      └─ RelOpノード抽出       ───▶ #relop
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| sp_BlitzCache.sql | `sp_BlitzCache.sql` | ソース | メインプロシージャ。XMLノード処理開始通知を出力（行3073） |
| Install-All-Scripts.sql | `Install-All-Scripts.sql` | インストール | 全スクリプトを含むインストールファイル（行16224） |
| Install-Azure.sql | `Install-Azure.sql` | インストール | Azure向けインストールファイル（行3959） |
