# 通知設計書 16-必須パラメータNULL

## 概要

本ドキュメントは、sp_BlitzCache ストアドプロシージャにおいて、必須パラメータがNULLに設定された場合に発生するエラー通知の設計書である。

### 本通知の処理概要

本通知は、クエリプランキャッシュ分析を実行する前に、必須パラメータの存在を検証し、いずれかがNULLの場合にエラーを通知してプロシージャを終了する機能を提供する。

**業務上の目的・背景**：sp_BlitzCacheは、複数の必須パラメータ（@Top, @SortOrder, @QueryFilter, @Reanalyze）を使用してプランキャッシュを分析する。これらのパラメータがNULLの場合、分析処理が正常に動作せず、予期しない結果やエラーが発生する可能性がある。そのため、処理開始前に必須パラメータの検証を行い、NULLの場合は明示的なエラーメッセージで通知する。

**通知の送信タイミング**：sp_BlitzCache実行時の初期検証フェーズで、@Top、@SortOrder、@QueryFilter、@Reanalyzeのいずれかがnullの場合にエラーが発生する。

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

**通知内容の概要**：複数のパラメータが必須であり、NULLに設定しないよう求めるエラーメッセージを含む。

**期待されるアクション**：受信者は、必須パラメータ（@Top, @SortOrder, @QueryFilter, @Reanalyze）に適切な値を指定してsp_BlitzCacheを再実行する。

## 通知種別

SQLメッセージ（RAISERROR）

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

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

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

### 本文テンプレート

```
Several parameters (@Top, @SortOrder, @QueryFilter, @Reanalyze) are required. Do not set them to NULL. Please try again.
```

### 添付ファイル

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

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| なし | - | - | - |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| プロシージャ実行 | sp_BlitzCache実行 | @Top IS NULL OR @SortOrder IS NULL OR @QueryFilter IS NULL OR @Reanalyze IS NULL | パラメータ検証フェーズで発生 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| 全必須パラメータがNULLでない | 全ての必須パラメータに値が設定されている場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[sp_BlitzCache実行] --> B{@Top IS NULL?}
    B -->|Yes| E[RAISERROR発行]
    B -->|No| C{@SortOrder IS NULL?}
    C -->|Yes| E
    C -->|No| D{@QueryFilter IS NULL?}
    D -->|Yes| E
    D -->|No| F{@Reanalyze IS NULL?}
    F -->|Yes| E
    F -->|No| G[検証OK - 処理継続]
    E --> H[RETURN - プロシージャ終了]
```

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

### 参照テーブル一覧

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

### 更新テーブル一覧

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

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 必須パラメータNULL | @Top, @SortOrder, @QueryFilter, @Reanalyzeのいずれかがnull | 必須パラメータに値を設定 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし

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

- パラメータのNULLチェックのみで、外部入力のバリデーションではないためセキュリティリスクはない

## 備考

- このエラーが発生した場合、sp_BlitzCacheはRETURNで即座に終了する
- @Topと@SortOrderにはプロシージャ内でデフォルト値が設定されるため、通常はユーザーが明示的にNULLを指定しない限り発生しない
- ソート順・クエリフィルタ検証の後に実行される

---

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

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

### 推奨読解順序

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

sp_BlitzCacheのパラメータ定義と、必須パラメータを理解する。

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

**読解のコツ**: CREATE PROCEDURE文のパラメータ宣言部分を確認し、各パラメータのデフォルト値と使用目的を理解する。

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

必須パラメータ検証ロジックの開始点を特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | sp_BlitzCache.sql | `sp_BlitzCache.sql` | 行1076-1084付近の必須パラメータ検証部分 |

**主要処理フロー**:
1. **行1076**: コメント「/* validate user inputs */」
2. **行1077-1080**: IF @Top IS NULL OR @SortOrder IS NULL OR @QueryFilter IS NULL OR @Reanalyze IS NULL
3. **行1082**: RAISERRORによるエラーメッセージ発行
4. **行1083**: RETURNによるプロシージャ終了

#### Step 3: デフォルト値設定を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | sp_BlitzCache.sql | `sp_BlitzCache.sql` | 行837-850付近の@Topデフォルト値設定部分 |

**主要処理フロー**:
- @Topが未設定の場合、@SortOrderに応じて5または10が設定される
- これにより、通常は@Top IS NULLは発生しない

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

```
sp_BlitzCache
    |
    +-- パラメータ前処理フェーズ
    |      |
    |      +-- @SortOrder = LOWER(@SortOrder)
    |      |
    |      +-- @Top デフォルト値設定（NULLの場合）
    |
    +-- ソート順検証フェーズ
    |
    +-- クエリフィルタ検証フェーズ
    |
    +-- 必須パラメータ検証フェーズ
    |      |
    |      +-- IF @Top IS NULL OR @SortOrder IS NULL OR ...
    |             |
    |             +-- RAISERROR 'Several parameters are required'
    |             |
    |             +-- RETURN
    |
    +-- 分析実行フェーズ（本エラー時は到達しない）
```

### データフロー図

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

@Top ─────────────────> NULL検証 ─────────────────> エラーメッセージ
@SortOrder               |                             |
@QueryFilter             v                             v
@Reanalyze         IS NULL チェック                RAISERROR
                   (OR条件)                        (Severity 16)
                         |
                         v
                   いずれかNULL
                         |
                         v
                      RETURN
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| sp_BlitzCache.sql | `sp_BlitzCache.sql` | ソース | プランキャッシュ分析プロシージャ本体 |
| Install-All-Scripts.sql | `Install-All-Scripts.sql` | インストールスクリプト | 全スクリプトの一括インストール |
| Install-Azure.sql | `Install-Azure.sql` | インストールスクリプト | Azure用インストールスクリプト |
