# 通知設計書 11-日時データ型エラー

## 概要

本ドキュメントは、sp_BlitzLock ストアドプロシージャにおいて、指定されたタイムスタンプカラムがdatetime型でない場合に発生するエラー通知の設計書である。

### 本通知の処理概要

本通知は、デッドロック情報を外部テーブルに保存する際に、タイムスタンプカラムのデータ型を検証し、不正な型が指定された場合にエラーを通知する機能を提供する。

**業務上の目的・背景**：sp_BlitzLockは、SQL Serverのデッドロック情報を分析・保存するためのプロシージャである。デッドロックの発生時刻を正確に記録するためには、タイムスタンプカラムがdatetime系のデータ型である必要がある。不正なデータ型が指定された場合、データの保存に失敗したり、時刻情報が破損する可能性があるため、事前に検証してエラーを通知する。

**通知の送信タイミング**：sp_BlitzLock実行時、@TargetTimestampColumnNameパラメータが指定され、かつ@TargetSessionTypeが'table'の場合に、指定されたカラムのデータ型を検証する。カラムの型名に'date'が含まれていない場合にエラーが発生する。

**通知の受信者**：sp_BlitzLockを実行したSQL Serverセッションの呼び出し元。通常はDBA（データベース管理者）やSQL Serverエージェントジョブ。

**通知内容の概要**：指定されたタイムスタンプカラム名と、datetime型である必要がある旨のエラーメッセージを含む。

**期待されるアクション**：受信者は、正しいdatetime型のカラム名を@TargetTimestampColumnNameパラメータに指定してsp_BlitzLockを再実行するか、ターゲットテーブルのスキーマを修正してカラムをdatetime型に変更する。

## 通知種別

SQLメッセージ（RAISERROR）

## 送信仕様

### 基本情報

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

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

実行中のSQL Serverセッションに対して直接メッセージを送信する。特定の宛先決定ロジックは不要。

## 通知テンプレート

### SQLメッセージの場合

| 項目 | 内容 |
|-----|------|
| Severity | 11 |
| State | 1 |
| WITH NOWAIT | あり |

### 本文テンプレート

```
The specified @TargetTimestampColumnName %s must be of datetime data type.
```

### 添付ファイル

| ファイル名 | 形式 | 条件 | 説明 |
|----------|------|------|------|
| なし | - | - | - |

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| @timestamp_column | タイムスタンプカラム名 | @TargetTimestampColumnNameパラメータ | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| プロシージャ実行 | sp_BlitzLock実行 | @TargetTimestampColumnNameが指定され、カラムの型名に'date'が含まれない | パラメータ検証フェーズで発生 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| @TargetSessionTypeがNULL | テーブル出力が指定されていない場合は検証しない |
| @TargetSessionTypeが'table'以外 | テーブル出力以外の場合は検証しない |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[sp_BlitzLock実行] --> B{@TargetSessionType = 'table'?}
    B -->|No| C[検証スキップ]
    B -->|Yes| D{@TargetTimestampColumnName指定あり?}
    D -->|No| E[検証スキップ]
    D -->|Yes| F[動的SQLで型検証実行]
    F --> G{sys.types.nameに'date'含む?}
    G -->|Yes| H[検証OK - 処理継続]
    G -->|No| I[RAISERROR発行]
    I --> J[RETURN - プロシージャ終了]
```

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

### 参照テーブル一覧

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

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

#### sys.columns / sys.types

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| c.name | カラム名 | WHERE c.name = @timestamp_column |
| ty.name | データ型名 | JOIN ON c.user_type_id = ty.user_type_id |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| なし | - | 本通知処理でデータ更新は行わない |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 日時データ型エラー | カラムがdatetime系でない | 正しいデータ型のカラムを指定 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし

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

- 動的SQL内でQUOTENAMEを使用してSQLインジェクションを防止
- カラム名、テーブル名、スキーマ名はパラメータとして渡される

## 備考

- このエラーが発生した場合、sp_BlitzLockはRETURNで即座に終了する
- ty.name LIKE '%date%' の条件により、datetime、datetime2、date、datetimeoffset等のデータ型が許可される

---

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

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

### 推奨読解順序

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

sp_BlitzLockのパラメータ定義と、ターゲットテーブル関連のパラメータを理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | sp_BlitzLock.sql | `sp_BlitzLock.sql` | プロシージャのパラメータ定義（@TargetTimestampColumnName等） |

**読解のコツ**: CREATE PROCEDURE文のパラメータ宣言部分を確認し、@TargetDatabaseName、@TargetSchemaName、@TargetTableName、@TargetColumnName、@TargetTimestampColumnNameの関連を理解する。

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

バリデーションロジックの開始点を特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | sp_BlitzLock.sql | `sp_BlitzLock.sql` | 行480-520付近のバリデーション動的SQL構築部分 |

**主要処理フロー**:
1. **行496-512**: @TargetTimestampColumnNameのデータ型検証用動的SQL構築
2. **行510**: RAISERRORによるエラーメッセージ発行
3. **行511**: RETURNによるプロシージャ終了

#### Step 3: 動的SQLの実行を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | sp_BlitzLock.sql | `sp_BlitzLock.sql` | 行515-530付近のsp_executesql実行部分 |

**主要処理フロー**:
- **行517-530**: sp_executesqlによる動的SQL実行とパラメータバインド

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

```
sp_BlitzLock
    |
    +-- パラメータ検証フェーズ
    |      |
    |      +-- @TargetSessionType = 'table' の場合
    |             |
    |             +-- @validation_sql 構築
    |             |
    |             +-- sys.sp_executesql(@validation_sql)
    |                    |
    |                    +-- sys.columns, sys.types, sys.tables, sys.schemas 参照
    |                    |
    |                    +-- 条件不一致時: RAISERROR + RETURN
    |
    +-- デッドロック分析フェーズ（本エラー時は到達しない）
```

### データフロー図

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

@TargetTimestampColumnName ──> 動的SQL構築 ──> sp_executesql ──> エラーメッセージ
@TargetDatabaseName           |                |                  |
@TargetSchemaName             v                v                  v
@TargetTableName              sys.columns      型チェック         RAISERROR
                              sys.types        (LIKE '%date%')    (Severity 11)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| sp_BlitzLock.sql | `sp_BlitzLock.sql` | ソース | デッドロック分析プロシージャ本体 |
| Install-All-Scripts.sql | `Install-All-Scripts.sql` | インストールスクリプト | 全スクリプトの一括インストール（sp_BlitzLock含む） |
| Install-Azure.sql | `Install-Azure.sql` | インストールスクリプト | Azure用インストールスクリプト |
