# 通知設計書 7-スキーマ不存在

## 概要

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

### 本通知の処理概要

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

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

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

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

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

**期待されるアクション**：正しいスキーマ名を確認し、プロシージャを再実行する。ターゲットデータベースの sys.schemas カタログビューでスキーマ名を確認することが推奨される。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

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

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

### 本文テンプレート

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

### 添付ファイル

該当なし

## テンプレート変数

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

## 送信トリガー・条件

### トリガー一覧

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

### 送信抑止条件

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

## 処理フロー

### 送信フロー

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

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| [TargetDatabase].sys.schemas | スキーマ存在確認 | 動的SQLで参照 |

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

#### sys.schemas

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| name | スキーマ名 | WHERE s.name = @schema |

### 更新テーブル一覧

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

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

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

## 備考

- sp_BlitzLock.sql の行401-413の動的SQL内で定義されている（行410-412）
- このチェックは動的SQLとして構築され、sp_executesql で実行される
- @TargetSchemaName が NULL の場合、デフォルト値として 'dbo' が設定される（行373-376）

---

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

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

### 推奨読解順序

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

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

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

**読解のコツ**: @TargetSchemaName は sysname 型であり、デフォルト値は NULL。NULL の場合は後で 'dbo' が設定される。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | sp_BlitzLock.sql | `sp_BlitzLock.sql` | 動的SQL変数 @validation_sql の構築（行401-468） |
| 2-2 | sp_BlitzLock.sql | `sp_BlitzLock.sql` | sp_executesql の実行（行517-531） |

**主要処理フロー**:
1. **行401**: SET @validation_sql = N' で動的SQLの構築開始
2. **行403-413**: スキーマ存在チェックのSQL構築
3. **行407-408**: QUOTENAME でデータベース名をサニタイズ
4. **行410-412**: RAISERROR ステートメントの構築
5. **行517-531**: sp_executesql でパラメータを渡して実行

#### Step 3: パラメータのデフォルト値設定を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | sp_BlitzLock.sql | `sp_BlitzLock.sql` | デフォルト値設定（行373-376） |

**主要処理フロー**:
- **行373**: IF @TargetSchemaName IS NULL の条件チェック
- **行375**: SET @TargetSchemaName = N'dbo' でデフォルト値設定

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

```
sp_BlitzLock (ストアドプロシージャ)
    │
    ├─ @TargetSchemaName の NULL チェック
    │      └─ NULL の場合は 'dbo' を設定
    │
    ├─ @validation_sql の構築
    │      └─ 動的SQLとしてスキーマ存在チェックを構築
    │
    ├─ QUOTENAME(@TargetDatabaseName)
    │      └─ データベース名のサニタイズ
    │
    ├─ sp_executesql
    │      └─ 動的SQLの実行
    │             │
    │             └─ [TargetDatabase].sys.schemas 参照
    │                    │
    │                    └─ 存在しない場合は RAISERROR
    │
    └─ RETURN
           └─ 処理終了
```

### データフロー図

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

@TargetSchemaName ────▶ NULL チェック ────────▶ 'dbo' or 指定値
       │
       ↓
       │
@TargetDatabaseName ──▶ QUOTENAME() ─────────▶ サニタイズ済み名
       │
       ↓
       │
       └─────────────▶ 動的SQL構築 ─────────▶ @validation_sql
                              │
                              ↓
                        sp_executesql
                              │
                              ↓
                        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 向けインストールスクリプト |
