# 通知設計書 45-スキーマ名無効

## 概要

本ドキュメントは、sp_BlitzIndexストアドプロシージャにおいて、指定された出力スキーマ名が存在しない場合に発生するエラー通知の設計を記載する。

### 本通知の処理概要

本通知は、分析結果の出力先として指定されたスキーマがデータベース内に存在しない場合にエラーメッセージを出力し、データの保存を中止する機能を提供する。

**業務上の目的・背景**：sp_BlitzIndexは分析結果をテーブルに永続化する機能を提供している。出力先テーブルを作成または使用する際、スキーマが存在することが前提となる。存在しないスキーマへの出力を試みるとテーブル作成やデータ挿入が失敗するため、事前にスキーマの存在を確認し、不存在の場合は明確なエラーメッセージでユーザーに通知する。これにより、データベース管理者が正しいスキーマを指定できるようガイダンスを提供する。

**通知の送信タイミング**：結果出力フェーズにおいて、@ValidOutputLocation = 1（有効な出力先が指定されている）の状態で、INFORMATION_SCHEMA.SCHEMATAを確認し、指定されたスキーマ名が存在しない場合に送信される。各モード（Mode 0/1/2/3）の結果出力セクションで個別にチェックされる。

**通知の受信者**：sp_BlitzIndexを実行したSQL Serverクライアントセッション。RAISERRORステートメントによりクライアントに直接エラーメッセージが返される。

**通知内容の概要**：エラーメッセージには、スキーマ名が無効であるためデータを保存できなかったことが明示される。

**期待されるアクション**：ユーザーは通知内容を確認し、(1) スキーマ名が正しいか確認、(2) スキーマが存在するか確認（INFORMATION_SCHEMA.SCHEMATAで確認）、(3) スキーマを作成するか、正しいスキーマ名を指定して再実行、のいずれかのアクションを取る。

## 通知種別

RAISERRORによるSQL Serverエラーメッセージ（クライアント通知）

## 送信仕様

### 基本情報

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

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

sp_BlitzIndexを実行したクライアントセッションに対して、RAISERRORステートメントにより直接エラーメッセージを送信する。

## 通知テンプレート

### エラーメッセージ

| 項目 | 内容 |
|-----|------|
| メッセージレベル | 16 |
| 状態 | 0 |
| 形式 | テキスト |

### 本文テンプレート

```
Invalid schema name, data could not be saved.
```

### 添付ファイル

なし

## テンプレート変数

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

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| プロシージャ実行 | sp_BlitzIndex実行（Mode 0/1/2/3） | @ValidOutputLocation = 1 かつ @SchemaExists != 1 | 結果出力フェーズで検出 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| @ValidOutputLocation = 0の場合 | 出力先が無効なため別の処理へ |
| @SchemaExists = 1の場合 | スキーマが存在するため正常処理 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[結果出力フェーズ開始] --> B{@ValidOutputLocation = 1?}
    B -->|No| C[別の処理へ]
    B -->|Yes| D{@SchemaExists = 1?}
    D -->|Yes| E[テーブル存在確認へ]
    D -->|No| F[RAISERROR: スキーマ名無効]
    F --> G[RETURN - 処理中断]
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| INFORMATION_SCHEMA.SCHEMATA | スキーマの存在確認 | 動的SQL経由で参照 |

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

#### INFORMATION_SCHEMA.SCHEMATA

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| SCHEMA_NAME | スキーマ名照合 | WHERE QUOTENAME(SCHEMA_NAME) = @OutputSchemaName |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| なし | なし | エラー発生時は即座にRETURNするため更新なし |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| スキーマ名無効 | INFORMATION_SCHEMA.SCHEMATAにスキーマが存在しない | エラーメッセージを出力し処理中断 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

- スキーマ名をエラーメッセージに含めず、固定メッセージとすることでセキュリティリスクを低減
- INFORMATION_SCHEMA.SCHEMATAへのアクセス権限が必要

## 備考

- @SchemaExistsフラグは、出力先検証フェーズで動的SQLにより設定される
- 同じエラーメッセージがsp_BlitzIndexの複数のモード（Mode 0, 1, 2, 3）で使用される
- リンクサーバー経由の場合も同様のチェックが行われる

---

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

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

### 推奨読解順序

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

スキーマ検証に関わる変数を理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | sp_BlitzIndex.sql | `sp_BlitzIndex.sql` | @SchemaExists、@TableExists変数の宣言（行3718-3719） |
| 1-2 | sp_BlitzIndex.sql | `sp_BlitzIndex.sql` | @OutputSchemaNameパラメータの定義 |

**読解のコツ**: @SchemaExistsと@TableExistsはBIT型変数で、動的SQLの実行結果として設定される。

#### Step 2: スキーマ存在確認ロジック

動的SQLによるスキーマ存在確認の処理を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | sp_BlitzIndex.sql | `sp_BlitzIndex.sql` | スキーマ存在確認の動的SQL（行3725-3743） |

**主要処理フロー**:
1. **行3726-3729**: @StringToExecuteに動的SQLを設定
2. **行3728**: INFORMATION_SCHEMA.SCHEMATAでスキーマ存在確認
3. **行3743**: sp_executesqlで動的SQLを実行し、@SchemaExistsに結果を設定

#### Step 3: エラー発生箇所の確認（Mode 0）

Mode 0での結果出力時のスキーマチェックを確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | sp_BlitzIndex.sql | `sp_BlitzIndex.sql` | Mode 0の結果出力セクション（行5931-5936） |

**主要処理フロー**:
- **行5933**: IF NOT @SchemaExists = 1 の条件判定
- **行5935**: RAISERROR (N'Invalid schema name, data could not be saved.', 16, 0)
- **行5936**: RETURN で処理中断

#### Step 4: 他のモードでの実装確認

Mode 1, 2, 3での同様のチェックを確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | sp_BlitzIndex.sql | `sp_BlitzIndex.sql` | Mode 1の結果出力（行6088-6091） |
| 4-2 | sp_BlitzIndex.sql | `sp_BlitzIndex.sql` | Mode 2の結果出力（行6640-6642） |
| 4-3 | sp_BlitzIndex.sql | `sp_BlitzIndex.sql` | Mode 3の結果出力（行6818-6821） |

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

```
sp_BlitzIndex
    │
    ├─ パラメータ初期化
    │
    ├─ 出力先検証フェーズ
    │      │
    │      ├─ データベース存在確認
    │      │
    │      └─ スキーマ/テーブル存在確認（動的SQL）
    │             ├─ @SchemaExists設定
    │             └─ @TableExists設定
    │
    ├─ メイン分析処理
    │
    └─ 結果出力フェーズ（各Mode共通）
           │
           ├─ @ValidOutputLocation = 1?
           │      │
           │      └─ @SchemaExists = 1?
           │             │
           │             ├─ Yes → テーブル処理へ
           │             │
           │             └─ No → RAISERROR（本通知）
           │                      └─ RETURN
           │
           └─ 画面出力（@OutputType != 'NONE'の場合）
```

### データフロー図

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

@OutputSchemaName ───▶ 動的SQL生成 ───▶ INFORMATION_SCHEMA.SCHEMATA
                                                  照会
                                                   │
                                                   ▼
                                           ┌─────────────────┐
                                           │ EXISTS確認       │
                                           │ QUOTENAME        │
                                           │ (SCHEMA_NAME)    │
                                           └─────────────────┘
                                                   │
                                                   ▼
                                           @SchemaExists設定
                                                   │
                             ┌─────────────────────┴─────────────────────┐
                             ▼                                           ▼
                      [@SchemaExists = 1]                         [@SchemaExists = 0]
                             │                                           │
                             ▼                                           ▼
                      テーブル処理へ                           RAISERROR → クライアント
                                                              "Invalid schema name,
                                                               data could not be saved."
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| sp_BlitzIndex.sql | `sp_BlitzIndex.sql` | ソース | インデックス分析プロシージャ、通知発生元（行5935, 6090, 6642, 6820） |
| Install-All-Scripts.sql | `Install-All-Scripts.sql` | ソース | 全スクリプトインストーラー（同一ロジック含む） |
| Install-Azure.sql | `Install-Azure.sql` | ソース | Azure用インストーラー（同一ロジック含む） |
