# 通知設計書 2-出力パラメータ未指定

## 概要

本ドキュメントは、SQL Server First Responder Kit の sp_BlitzFirst、sp_BlitzCache 等のストアドプロシージャにおいて、@OutputType が 'NONE' に設定されているにもかかわらず、必要な出力パラメータが指定されていない場合に発生するエラー通知について定義する。

### 本通知の処理概要

本通知は、結果を外部テーブルに出力する設定（@OutputType = 'NONE'）を使用する際に、出力先の指定が不完全な場合にエラーを発生させ、不正な設定での実行を防止するバリデーション機能である。

**業務上の目的・背景**：sp_BlitzFirst や sp_BlitzCache などの診断プロシージャは、結果を画面に表示する代わりにデータベーステーブルに保存するオプション（@OutputType = 'NONE'）を提供している。この機能を使用する場合、出力先のデータベース名、スキーマ名、テーブル名を全て指定する必要がある。不完全な設定で実行すると、結果が正しく保存されないか、エラーが発生するため、事前にバリデーションを行う。

**通知の送信タイミング**：プロシージャの実行開始直後、パラメータのサニタイズ処理後に @OutputType が 'NONE' であるかをチェックし、その場合に @OutputTableName、@OutputSchemaName、@OutputDatabaseName のいずれかが NULL かどうかを判定する。

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

**通知内容の概要**：「This procedure should be called with a value for all @Output* parameters, as @OutputType is set to NONE」というメッセージで、必須パラメータの指定が必要であることを通知する。

**期待されるアクション**：@OutputDatabaseName、@OutputSchemaName、@OutputTableName の全てのパラメータに適切な値を指定してプロシージャを再実行する。または、@OutputType を 'TABLE' などの別の値に変更する。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

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

| 項目 | 内容 |
|-----|------|
| メッセージ形式 | RAISERROR |
| Severity | 12 |
| State | 1 |
| WITH句 | なし |

### 本文テンプレート

```
This procedure should be called with a value for all @Output* parameters, as @OutputType is set to NONE
```

### 添付ファイル

該当なし

## テンプレート変数

該当なし（固定メッセージ）

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| ストアドプロシージャ実行 | sp_BlitzFirst の実行 | @OutputType = 'NONE' かつ 出力パラメータのいずれかが NULL | パラメータ検証 |
| ストアドプロシージャ実行 | sp_BlitzCache の実行 | @OutputType = 'NONE' かつ 出力パラメータのいずれかが NULL | パラメータ検証 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| @OutputType != 'NONE' | 出力タイプが 'NONE' でない場合はチェック不要 |
| 全出力パラメータが指定済み | @OutputTableName、@OutputSchemaName、@OutputDatabaseName が全て指定されている |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[プロシージャ実行開始] --> B{@OutputType = 'NONE' か?}
    B -->|No| C[処理続行]
    B -->|Yes| D{出力パラメータチェック}
    D -->|全て指定済| E[処理続行]
    D -->|いずれかが NULL| F[RAISERROR 発行]
    F --> G[RETURN で処理終了]
    C --> H[メイン処理]
    E --> H
```

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

### 参照テーブル一覧

該当なし（パラメータのみのチェック）

### 更新テーブル一覧

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

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| パラメータ不足 | @OutputType = 'NONE' で出力パラメータが不完全 | 全ての出力パラメータを指定して再実行 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

- 出力先のデータベース名、スキーマ名、テーブル名はエラーメッセージに含まれないため、情報漏洩のリスクは低い

## 備考

- sp_BlitzFirst.sql の行183-186で定義されている
- sp_BlitzCache.sql の行821-825で定義されている
- 複数のプロシージャで同様のバリデーションロジックが実装されている

---

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

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

### 推奨読解順序

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

出力パラメータの定義を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | sp_BlitzFirst.sql | `sp_BlitzFirst.sql` | @OutputType, @OutputDatabaseName, @OutputSchemaName, @OutputTableName パラメータ定義 |
| 1-2 | sp_BlitzCache.sql | `sp_BlitzCache.sql` | 同様のパラメータ定義（行252-256） |

**読解のコツ**: 各プロシージャのパラメータ定義部分で、これらのパラメータのデフォルト値（通常は NULL）を確認する。

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

バリデーションが実行されるタイミングを確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | sp_BlitzFirst.sql | `sp_BlitzFirst.sql` | パラメータサニタイズ処理（行169-181） |
| 2-2 | sp_BlitzFirst.sql | `sp_BlitzFirst.sql` | @OutputType のバリデーション（行183-187） |

**主要処理フロー**:
1. **行169-181**: 各出力パラメータに QUOTENAME を適用してサニタイズ
2. **行183**: @OutputType = 'NONE' の条件チェック
3. **行184**: 出力パラメータの NULL チェック
4. **行185**: RAISERROR でエラーメッセージ出力
5. **行186**: RETURN で処理終了

#### Step 3: sp_BlitzCache での実装を確認する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | sp_BlitzCache.sql | `sp_BlitzCache.sql` | @OutputType のバリデーション（行821-825） |

**主要処理フロー**:
- **行821**: @OutputType = 'NONE' の条件チェック
- **行822**: 出力パラメータの NULL チェック
- **行823**: RAISERROR でエラーメッセージ出力
- **行824**: RETURN で処理終了

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

```
sp_BlitzFirst / sp_BlitzCache (ストアドプロシージャ)
    │
    ├─ UPPER(@OutputType)
    │      └─ 出力タイプを大文字に変換
    │
    ├─ 条件判定: @OutputType = 'NONE'
    │      └─ 出力パラメータのNULLチェック
    │
    └─ RAISERROR
           └─ エラーメッセージをクライアントに送信
```

### データフロー図

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

@OutputType ─────────────▶ UPPER() ─────────────▶ 大文字変換結果
       │
       ↓ 'NONE' の場合
       │
@OutputDatabaseName ──▶ IS NULL チェック ──▶ 結果
@OutputSchemaName ────▶ IS NULL チェック ──▶ 結果
@OutputTableName ─────▶ IS NULL チェック ──▶ 結果
       │
       ↓ いずれかが NULL
       │
       └─────────────────▶ RAISERROR ──▶ エラーメッセージ
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| sp_BlitzFirst.sql | `sp_BlitzFirst.sql` | ソース | リアルタイム診断プロシージャ |
| sp_BlitzCache.sql | `sp_BlitzCache.sql` | ソース | プランキャッシュ分析プロシージャ |
| Install-All-Scripts.sql | `Install-All-Scripts.sql` | ソース | 全スクリプトをまとめたインストールファイル |
| sp_BlitzIndex.sql | `sp_BlitzIndex.sql` | ソース | 同様のバリデーションを持つプロシージャ |
