# 通知設計書 10-XMLデータ型エラー

## 概要

本ドキュメントは、SQL Server First Responder Kit の sp_BlitzLock ストアドプロシージャにおいて、@TargetColumnName パラメータで指定されたカラムが XML データ型でない場合に発生するエラー通知について定義する。

### 本通知の処理概要

本通知は、sp_BlitzLock プロシージャでカスタムテーブルからデッドロックXMLを読み込む際に、指定されたターゲットカラムが XML データ型でない場合にエラーを発生させ、不正なデータ型のカラム指定での処理実行を防止するバリデーション機能である。

**業務上の目的・背景**：sp_BlitzLock は @TargetSessionType = 'table' を指定すると、ユーザーが用意したテーブルからデッドロックXMLを読み込むことができる。デッドロック情報は XML 形式で格納されるため、@TargetColumnName で指定するカラムは必ず XML データ型である必要がある。VARCHAR や NVARCHAR などの他のデータ型のカラムが指定された場合、XMLパース処理でエラーが発生する可能性があるため、事前にデータ型の検証を行う。

**通知の送信タイミング**：@TargetColumnName の存在チェックに成功した後、動的SQLを使用してターゲットデータベース内の sys.columns と sys.types カタログビューを JOIN して参照し、カラムのデータ型が 'xml' であるかを確認する。データ型が XML でない場合に本エラーが発生する。

**通知の受信者**：プロシージャを実行したユーザー（SQL Server セッションの呼び出し元）がエラーメッセージを受信する。

**通知内容の概要**：「The specified @TargetColumnName %s must be of XML data type.」というメッセージで、カラム名が挿入される。

**期待されるアクション**：XML データ型のカラムを指定してプロシージャを再実行する。または、デッドロックXMLを格納するための XML 型のカラムを持つテーブルを新規に作成する。

## 通知種別

RAISERROR による SQL Server メッセージ出力（クライアントアプリケーションへの同期通知）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期 |
| 優先度 | 高（Severity 11, State 1） |
| リトライ | なし（即時RETURN） |

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

プロシージャを実行したセッションに対して直接メッセージを送信する。送信先は固定であり、動的な決定ロジックは存在しない。

## 通知テンプレート

### メッセージ通知の場合

| 項目 | 内容 |
|-----|------|
| メッセージ形式 | RAISERROR |
| Severity | 11 |
| State | 1 |
| WITH句 | NOWAIT |

### 本文テンプレート

```
The specified @TargetColumnName %s must be of XML data type.
```

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| %s（カラム名） | 指定されたターゲットカラム名 | @TargetColumnName パラメータ | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| ストアドプロシージャ実行 | sp_BlitzLock の実行 | @TargetSessionType = 'table' かつ カラムのデータ型が XML でない | XMLデータ型チェック |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| @TargetSessionType != 'table' | テーブルモード以外ではチェック不要 |
| データベースが存在しない | データベース存在チェックで先にエラー |
| スキーマが存在しない | スキーマ存在チェックで先にエラー |
| テーブルが存在しない | テーブル存在チェックで先にエラー |
| カラムが存在しない | カラム存在チェックで先にエラー |
| カラムが XML データ型 | sys.types.name = N'xml' の場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[カラム存在チェック通過] --> B[動的SQLで sys.columns + sys.types 参照]
    B --> C{データ型が XML か?}
    C -->|Yes| D[タイムスタンプカラムチェックへ]
    C -->|No| E[RAISERROR 発行]
    E --> F[RETURN で処理終了]
    D --> G[処理続行]
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| [TargetDatabase].sys.columns | カラム情報取得 | 動的SQLで参照 |
| [TargetDatabase].sys.types | データ型確認 | 動的SQLで参照 |
| [TargetDatabase].sys.tables | テーブルとの結合 | 動的SQLで参照 |
| [TargetDatabase].sys.schemas | スキーマとの結合 | 動的SQLで参照 |

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

#### sys.columns

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| name | カラム名 | WHERE c.name = @column |
| user_type_id | ユーザー定義型ID | JOIN 条件 |

#### sys.types

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| name | データ型名 | WHERE ty.name = N'xml' |
| user_type_id | ユーザー定義型ID | JOIN 条件 |

### 更新テーブル一覧

該当なし（エラー発生時は更新なし）

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| データ型エラー | 指定されたカラムが XML データ型でない | XML データ型のカラムを指定して再実行 |

### リトライ仕様

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

## 配信設定

### レート制限

該当なし（同期的なエラーメッセージ出力）

### 配信時間帯

制限なし（プロシージャ実行時に即時発生）

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

- 指定されたカラム名がエラーメッセージに含まれるが、これはユーザーが指定した値であり、情報漏洩のリスクは低い

## 備考

- sp_BlitzLock.sql の行448-468の動的SQL内で定義されている（行465-467）
- このチェックは動的SQLとして構築され、sp_executesql で実行される
- sys.columns と sys.types を user_type_id で JOIN してデータ型を確認する
- ty.name = N'xml' でXMLデータ型かどうかを判定する

---

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

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

### 推奨読解順序

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

パラメータの定義と型を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | sp_BlitzLock.sql | `sp_BlitzLock.sql` | @TargetColumnName パラメータ定義（行25） |

**読解のコツ**: @TargetColumnName は sysname 型であり、このカラムに XML データが格納されている必要がある。

#### Step 2: 動的SQLの構築を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | sp_BlitzLock.sql | `sp_BlitzLock.sql` | XMLデータ型チェックのSQL構築（行448-468） |

**主要処理フロー**:
1. **行448**: コメント「/* Validate column is XML type */」
2. **行449**: IF NOT EXISTS 句の開始
3. **行453-458**: sys.columns、sys.types、sys.tables、sys.schemas を JOIN
4. **行459-463**: WHERE 条件（カラム名、テーブル名、スキーマ名、ty.name = N'xml'）
5. **行465-467**: RAISERROR ステートメントの構築

#### Step 3: sys.types との JOIN を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | sp_BlitzLock.sql | `sp_BlitzLock.sql` | sys.columns と sys.types の JOIN（行454） |

**主要処理フロー**:
- **行454**: JOIN sys.types AS ty
- **行455**: ON c.user_type_id = ty.user_type_id
- **行463**: AND ty.name = N'xml' で XML データ型を判定

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

```
sp_BlitzLock (ストアドプロシージャ)
    │
    ├─ カラム存在チェック通過
    │
    ├─ @validation_sql への追加
    │      └─ XMLデータ型チェックSQLを追加構築
    │
    ├─ QUOTENAME(@TargetDatabaseName)
    │      └─ データベース名のサニタイズ
    │
    ├─ sp_executesql
    │      └─ 動的SQLの実行
    │             │
    │             └─ [TargetDatabase].sys.columns 参照
    │                    │
    │                    └─ [TargetDatabase].sys.types と JOIN
    │                           │
    │                           └─ ty.name = N'xml' で判定
    │                                  │
    │                                  └─ XML でない場合は RAISERROR
    │
    └─ RETURN
           └─ 処理終了
```

### データフロー図

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

@TargetColumnName ───▶ 動的SQL構築 ─────────▶ @validation_sql
       │
@TargetTableName ────▶ WHERE 条件 ─────────▶ フィルタ条件
       │
@TargetSchemaName ───▶ WHERE 条件 ─────────▶ フィルタ条件
       │
@TargetDatabaseName ─▶ QUOTENAME() ─────────▶ サニタイズ済み名
       │
       ↓
       │
       └─────────────▶ sp_executesql ─────────▶ 動的SQL実行
                              │
                              ↓
                        sys.columns JOIN sys.types
                              │
                              ↓ ty.name != N'xml' の場合
                              │
                              └───▶ RAISERROR ──▶ エラーメッセージ
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| sp_BlitzLock.sql | `sp_BlitzLock.sql` | ソース | デッドロック分析プロシージャ |
| Install-All-Scripts.sql | `Install-All-Scripts.sql` | ソース | 全スクリプトをまとめたインストールファイル |
| Install-Azure.sql | `Install-Azure.sql` | ソース | Azure SQL DB 向けインストールスクリプト |
