# 通知設計書 47-出力先無効&出力要求なし

## 概要

本ドキュメントは、sp_BlitzIndexストアドプロシージャにおいて、出力先が無効であり、かつ画面出力も要求されていない場合に発生するエラー通知の設計を記載する。

### 本通知の処理概要

本通知は、結果の出力先として有効なテーブルが指定されておらず、かつ@OutputType = 'NONE'が指定されている場合（つまり、結果をどこにも出力しない設定になっている場合）にエラーメッセージを出力し、処理を中断する機能を提供する。

**業務上の目的・背景**：sp_BlitzIndexは分析結果を画面に表示するか、テーブルに永続化するか、またはその両方を行うことができる。しかし、出力先テーブルが正しく指定されておらず（@ValidOutputLocation = 0）、かつ画面出力も無効化されている（@OutputType = 'NONE'）場合、処理を実行しても結果がどこにも出力されない無意味な状態となる。このような設定ミスを早期に検出し、ユーザーに通知する。

**通知の送信タイミング**：出力先検証フェーズの終了時に、@ValidOutputLocation = 0 かつ @OutputType = 'NONE' の条件が満たされた場合に送信される。

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

**通知内容の概要**：エラーメッセージには、出力先が無効であり、出力も要求されていないことが明示される。

**期待されるアクション**：ユーザーは通知内容を確認し、(1) 有効な出力先テーブルを指定する、または (2) @OutputTypeを'TABLE'などに変更して画面出力を有効化する、のいずれかのアクションを取る。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

### エラーメッセージ

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

### 本文テンプレート

```
Invalid output location and no output asked
```

### 添付ファイル

なし

## テンプレート変数

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

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| プロシージャ実行 | sp_BlitzIndex実行 | @ValidOutputLocation = 0 AND @OutputType = 'NONE' | 出力先検証フェーズの終了時に検出 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| @ValidOutputLocation = 1の場合 | 有効な出力先が指定されている |
| @OutputType != 'NONE'の場合 | 画面出力が要求されている |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[出力先検証フェーズ] --> B{@OutputServerName != NULL?}
    B -->|Yes| C[リンクサーバー検証]
    B -->|No| D[ローカル出力検証]
    C --> E{検証結果}
    D --> E
    E --> F{@ValidOutputLocation = 0?}
    F -->|No| G[メイン処理へ]
    F -->|Yes| H{@OutputType = 'NONE'?}
    H -->|No| I[画面出力のみで処理継続]
    H -->|Yes| J[RAISERROR: 出力先無効&出力要求なし]
    J --> K[RETURN - 処理中断]
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| なし | パラメータ検証のみのためテーブル参照なし | - |

### 更新テーブル一覧

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

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 出力先無効&出力要求なし | @ValidOutputLocation = 0 AND @OutputType = 'NONE' | エラーメッセージを出力し処理中断 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

- パラメータ値のみを検証するため、個人情報の漏洩リスクはない
- エラーメッセージにはシステム内部情報は含まれない

## 備考

- Severity 12は警告レベルであり、Severity 16（エラー）より低い
- このエラーは設定ミスの早期検出を目的としており、実際のデータベース操作に影響はない
- @OutputTypeのデフォルト値は'TABLE'であるため、明示的に'NONE'を指定しない限りこのエラーは発生しにくい

---

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

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

### 推奨読解順序

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

出力関連のパラメータと変数を理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | sp_BlitzIndex.sql | `sp_BlitzIndex.sql` | @OutputTypeパラメータの定義（デフォルト'TABLE'） |
| 1-2 | sp_BlitzIndex.sql | `sp_BlitzIndex.sql` | @ValidOutputLocation変数の宣言（行3637） |

**読解のコツ**: @ValidOutputLocationは出力先検証の結果を保持するBIT型変数で、有効な出力先が見つかった場合に1が設定される。

#### Step 2: 出力先検証ロジック

@ValidOutputLocationの設定ロジックを理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | sp_BlitzIndex.sql | `sp_BlitzIndex.sql` | 出力先検証セクション（行3632-3706） |

**主要処理フロー**:
1. **行3642**: @OutputServerNameがNOT NULLの場合、リンクサーバー検証
2. **行3656-3657**: リンクサーバーDBが有効な場合、@ValidOutputLocation = 1
3. **行3668-3691**: ローカルサーバーの場合の検証
4. **行3702-3705**: いずれの条件も満たさない場合、@ValidOutputLocation = 0

#### Step 3: エラー発生箇所の確認

本エラーの発生条件とRAISERROR実装を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | sp_BlitzIndex.sql | `sp_BlitzIndex.sql` | エラー発生箇所（行3708-3712） |

**主要処理フロー**:
- **行3708**: IF (@ValidOutputLocation = 0 AND @OutputType = 'NONE') の条件判定
- **行3710**: RAISERROR('Invalid output location and no output asked', 12, 1)
- **行3711**: RETURN で処理中断

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

```
sp_BlitzIndex
    │
    ├─ パラメータ初期化
    │
    ├─ 出力先検証フェーズ
    │      │
    │      ├─ リンクサーバー検証（@OutputServerName != NULL）
    │      │      └─ 成功時: @ValidOutputLocation = 1
    │      │
    │      ├─ グローバル一時テーブル検証
    │      │      └─ 成功時: @ValidOutputLocation = 1
    │      │
    │      ├─ ローカルテーブル検証
    │      │      └─ 成功時: @ValidOutputLocation = 1
    │      │
    │      └─ 上記以外
    │             └─ @ValidOutputLocation = 0
    │
    ├─ 出力要否チェック（行3708-3712）
    │      │
    │      └─ @ValidOutputLocation = 0 AND @OutputType = 'NONE'?
    │             │
    │             ├─ Yes → RAISERROR（本通知） → RETURN
    │             │
    │             └─ No → 処理継続
    │
    └─ メイン分析処理
```

### データフロー図

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

@OutputServerName ──┐
@OutputDatabaseName ┼──▶ 出力先検証 ───▶ @ValidOutputLocation
@OutputSchemaName ──┤
@OutputTableName ───┘
                                         │
                                         ▼
@OutputType ───────────────────▶ 条件判定
                                         │
                           ┌─────────────┴─────────────┐
                           ▼                           ▼
                   [@ValidOutputLocation=1]   [@ValidOutputLocation=0]
                           │                   AND [@OutputType='NONE']
                           │                           │
                           ▼                           ▼
                    処理継続              RAISERROR → クライアント
                                          "Invalid output location
                                           and no output asked"
```

### 関連ファイル一覧

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