# 通知設計書 71-sp_BlitzCache完了

## 概要

本ドキュメントは、SQL Server First Responder Kitのsp_BlitzFirstプロシージャにおいて、sp_BlitzCacheの呼び出しが完了した際に出力される情報通知「sp_BlitzCache完了」について定義する。

### 本通知の処理概要

本通知は、sp_BlitzFirstプロシージャ内でsp_BlitzCacheストアドプロシージャの実行が正常に完了したことをユーザーに通知するための情報メッセージである。

**業務上の目的・背景**：sp_BlitzFirstは、SQL Serverのパフォーマンス診断を行う包括的なプロシージャであり、内部でsp_BlitzCacheを呼び出してプランキャッシュの分析を行う。この通知は、プランキャッシュ分析フェーズが完了し、次のフェーズに進む準備ができたことを管理者に知らせるために必要である。長時間実行される診断処理において、進捗状況を把握するための重要な情報となる。

**通知の送信タイミング**：sp_BlitzFirstプロシージャ内でsp_BlitzCacheの呼び出しが完了した直後に送信される。具体的には、@CheckProcedureCacheパラメータが有効な場合に、sp_BlitzCacheの実行完了後にRAISERRORステートメントによって出力される。

**通知の受信者**：SQL Server Management Studio（SSMS）やその他のクライアントツールでsp_BlitzFirstを実行している管理者・DBA。メッセージタブに情報として表示される。

**通知内容の概要**：「sp_BlitzCache Finished」という固定メッセージが出力される。これにより、プランキャッシュ分析が完了したことが明確に示される。

**期待されるアクション**：この通知は情報提供目的であり、特別なアクションは不要。管理者は診断処理が順調に進行していることを確認し、次の処理フェーズの完了を待つことができる。

## 通知種別

コンソール出力（RAISERROR WITH NOWAIT）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（WITH NOWAIT指定により即時出力） |
| 優先度 | 低（情報レベル：severity 10） |
| リトライ | 無し |

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

実行中のセッションのクライアント（SSMSのメッセージタブ等）に対して直接出力される。特定の宛先決定ロジックは存在しない。

## 通知テンプレート

### コンソール出力の場合

| 項目 | 内容 |
|-----|------|
| 出力先 | クライアントのメッセージストリーム |
| メッセージレベル | 10（情報） |
| 状態 | 1 |

### 本文テンプレート

```
sp_BlitzCache Finished
```

### 添付ファイル

なし

## テンプレート変数

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

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| プロシージャ内部処理 | sp_BlitzCache実行完了 | @CheckProcedureCacheが有効かつsp_BlitzCache実行後 | sp_BlitzFirstがプランキャッシュチェックを行う設定で実行され、sp_BlitzCacheの呼び出しが完了した場合 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| @CheckProcedureCache = 0 | プランキャッシュチェックが無効の場合、sp_BlitzCache自体が実行されないため通知も出力されない |
| @OutputType = 'NONE' | 出力タイプがNONEの場合、一部の処理がスキップされる可能性がある |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[sp_BlitzFirst開始] --> B{@CheckProcedureCache有効?}
    B -->|Yes| C[sp_BlitzCache呼び出し]
    B -->|No| D[プランキャッシュチェックをスキップ]
    C --> E[sp_BlitzCache実行]
    E --> F[sp_BlitzCache完了]
    F --> G["RAISERROR('sp_BlitzCache Finished',10,1) WITH NOWAIT"]
    G --> H[次の処理フェーズへ]
    D --> H
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| sys.dm_exec_query_stats | sp_BlitzCache内でプランキャッシュ統計を取得 | sp_BlitzCache呼び出し前に参照 |
| sys.dm_exec_cached_plans | キャッシュされた実行プランの取得 | sp_BlitzCache内で使用 |

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

本通知自体はRAISERRORによる単純なメッセージ出力のため、直接的なテーブル参照は行わない。

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| なし | - | 本通知はログ出力のみで更新処理は行わない |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 該当なし | 本通知は情報出力のみでエラーは発生しない | - |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし（sp_BlitzFirst実行時に常に出力）

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

- 本通知は固定の情報メッセージであり、機密情報を含まない
- VIEW SERVER STATE権限を持つユーザーのみがsp_BlitzFirstを実行可能

## 備考

- WITH NOWAIT指定により、バッファリングされずに即時クライアントに送信される
- Severity 10はSQL Serverにおいて情報メッセージを示す
- sp_BlitzCacheの実行時間は、プランキャッシュのサイズや@Topパラメータの値によって大きく異なる

---

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

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

### 推奨読解順序

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

sp_BlitzFirstとsp_BlitzCacheの関係性を理解するため、まずパラメータと一時テーブル構造を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | sp_BlitzFirst.sql | `sp_BlitzFirst.sql` | @CheckProcedureCacheパラメータの定義と用途を確認 |
| 1-2 | sp_BlitzCache.sql | `sp_BlitzCache.sql` | sp_BlitzCacheのパラメータと戻り値の構造を理解 |

**読解のコツ**: T-SQLのストアドプロシージャでは、先頭部分でパラメータ宣言を確認し、WITH RECOMPILE等のオプションにも注目する。

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

sp_BlitzFirst内でsp_BlitzCacheが呼び出される箇所を特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | sp_BlitzFirst.sql | `sp_BlitzFirst.sql` | sp_BlitzCache呼び出し部分（行3800-3902付近） |

**主要処理フロー**:
1. **行3850付近**: sp_BlitzCacheの存在確認とバージョンチェック
2. **行3870付近**: sp_BlitzCacheの動的実行
3. **行3900**: RAISERRORによる完了通知出力

#### Step 3: 通知出力処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | sp_BlitzFirst.sql | `sp_BlitzFirst.sql` | 行3900のRAISERROR文の詳細 |

**主要処理フロー**:
- **行3900**: `RAISERROR('sp_BlitzCache Finished',10,1) WITH NOWAIT;`

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

```
sp_BlitzFirst（エントリーポイント）
    │
    ├─ パラメータ検証
    │
    ├─ 待機統計キャプチャ（第1パス）
    │
    ├─ sp_BlitzCache呼び出し
    │      │
    │      └─ プランキャッシュ分析実行
    │
    └─ RAISERROR('sp_BlitzCache Finished') ← 本通知
```

### データフロー図

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

@CheckProcedureCache ───▶ sp_BlitzFirst               ───▶ クライアントメッセージ
= 1                        │                                 「sp_BlitzCache Finished」
                           ├─ sp_BlitzCache実行
                           │
                           └─ RAISERROR出力
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| sp_BlitzFirst.sql | `sp_BlitzFirst.sql` | ソース | 親プロシージャ。sp_BlitzCacheを呼び出し、完了通知を出力 |
| sp_BlitzCache.sql | `sp_BlitzCache.sql` | ソース | プランキャッシュ分析を行う子プロシージャ |
| Install-All-Scripts.sql | `Install-All-Scripts.sql` | インストール | 全スクリプトを含むインストールファイル |
| Install-Azure.sql | `Install-Azure.sql` | インストール | Azure向けインストールファイル |
