# 通知設計書 9-カラム不存在

## 概要

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

### 本通知の処理概要

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

**業務上の目的・背景**：sp_BlitzLock は @TargetSessionType = 'table' を指定すると、ユーザーが用意したテーブルからデッドロックXMLを読み込むことができる。この場合、@TargetColumnName でデッドロックXMLが格納されているカラム名を指定する必要がある。テーブルは存在するがカラムが存在しない場合、データを読み込めないため、テーブル存在チェック後にカラムの存在確認を行う。

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

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

**通知内容の概要**：「The specified @TargetColumnName %s does not exist in table %s.%s in database %s.」というメッセージで、カラム名、スキーマ名、テーブル名、データベース名が挿入される。

**期待されるアクション**：正しいカラム名を確認し、プロシージャを再実行する。ターゲットテーブルの INFORMATION_SCHEMA.COLUMNS または sys.columns でカラム名を確認することが推奨される。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

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

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

### 本文テンプレート

```
The specified @TargetColumnName %s does not exist in table %s.%s in database %s.
```

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| %s（カラム名） | 指定されたターゲットカラム名 | @TargetColumnName パラメータ | Yes |
| %s（スキーマ名） | 指定されたターゲットスキーマ名 | @TargetSchemaName パラメータ | Yes |
| %s（テーブル名） | 指定されたターゲットテーブル名 | @TargetTableName パラメータ | Yes |
| %s（データベース名） | 指定されたターゲットデータベース名 | @TargetDatabaseName パラメータ | Yes |

## 送信トリガー・条件

### トリガー一覧

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

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| @TargetSessionType != 'table' | テーブルモード以外ではチェック不要 |
| データベースが存在しない | データベース存在チェックで先にエラー |
| スキーマが存在しない | スキーマ存在チェックで先にエラー |
| テーブルが存在しない | テーブル存在チェックで先にエラー |
| カラムが存在する | sys.columns に該当レコードがある場合 |

## 処理フロー

### 送信フロー

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

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| [TargetDatabase].sys.columns | カラム存在確認 | 動的SQLで参照 |
| [TargetDatabase].sys.tables | テーブルとの結合 | 動的SQLで参照 |
| [TargetDatabase].sys.schemas | スキーマとの結合 | 動的SQLで参照 |

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

#### sys.columns

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| name | カラム名 | WHERE c.name = @column |
| object_id | オブジェクトID | JOIN 条件 |

#### sys.tables

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| name | テーブル名 | WHERE t.name = @table |
| object_id | オブジェクトID | JOIN 条件 |
| schema_id | スキーマID | JOIN 条件 |

### 更新テーブル一覧

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

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| カラム不存在 | 指定されたカラムが存在しない | 正しいカラム名を確認して再実行 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

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

## 備考

- sp_BlitzLock.sql の行430-446の動的SQL内で定義されている（行443-445）
- このチェックは動的SQLとして構築され、sp_executesql で実行される
- sys.columns、sys.tables、sys.schemas を JOIN してカラム存在を確認する

---

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

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

### 推奨読解順序

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

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

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

**読解のコツ**: @TargetColumnName は sysname 型であり、デフォルト値は NULL。必須パラメータである点に注意。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | sp_BlitzLock.sql | `sp_BlitzLock.sql` | カラム存在チェックのSQL構築（行430-446） |

**主要処理フロー**:
1. **行430**: IF NOT EXISTS 句の開始
2. **行434-438**: sys.columns、sys.tables、sys.schemas を JOIN
3. **行439-441**: WHERE 条件（カラム名、テーブル名、スキーマ名）
4. **行443-445**: RAISERROR ステートメントの構築

#### Step 3: 3テーブル JOIN を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | sp_BlitzLock.sql | `sp_BlitzLock.sql` | sys.columns、sys.tables、sys.schemas の JOIN（行435-438） |

**主要処理フロー**:
- **行435**: JOIN sys.tables AS t
- **行436**: ON c.object_id = t.object_id
- **行437**: JOIN sys.schemas AS s
- **行438**: ON t.schema_id = s.schema_id

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

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

### データフロー図

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

@TargetColumnName ───▶ 動的SQL構築 ─────────▶ @validation_sql
       │
@TargetTableName ────▶ WHERE 条件 ─────────▶ フィルタ条件
       │
@TargetSchemaName ───▶ WHERE 条件 ─────────▶ フィルタ条件
       │
@TargetDatabaseName ─▶ QUOTENAME() ─────────▶ サニタイズ済み名
       │
       ↓
       │
       └─────────────▶ sp_executesql ─────────▶ 動的SQL実行
                              │
                              ↓
                        sys.columns JOIN sys.tables JOIN sys.schemas
                              │
                              ↓ 存在しない場合
                              │
                              └───▶ RAISERROR ──▶ エラーメッセージ
```

### 関連ファイル一覧

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