# 通知設計書 70-sp_BlitzCache呼び出し

## 概要

本ドキュメントは、SQL Server First Responder Kitのsp_BlitzFirstストアドプロシージャにおける「sp_BlitzCache呼び出し」通知（RAISERROR）の設計を定義する。

### 本通知の処理概要

この通知は、sp_BlitzFirstの実行時にsp_BlitzCacheストアドプロシージャを呼び出すフェーズの開始を示す進捗情報メッセージである。

**業務上の目的・背景**：sp_BlitzFirstは、パフォーマンス診断の一環としてsp_BlitzCacheを呼び出し、プランキャッシュの詳細分析を行うことができる。sp_BlitzCacheは、実行計画の問題点（暗黙的な型変換、テーブルスキャン、パラメータスニッフィングなど）を検出し、クエリパフォーマンスの改善点を特定する。この機能はオプションであり、@OutputTableNameBlitzCacheパラメータが設定されている場合にのみ有効化される。この通知により、DBAはsp_BlitzCacheの実行が開始されたことを確認できる。

**通知の送信タイミング**：sp_BlitzFirstの行3806で、@OutputTableNameBlitzCache、@OutputDatabaseName、@OutputSchemaNameがすべて設定されており、出力データベースが存在する場合にRAISERRORが発行される。

**通知の受信者**：SSMSやその他のSQLクライアントツールを使用してストアドプロシージャを実行しているDBAまたはシステム管理者。

**通知内容の概要**：「Calling sp_BlitzCache」というメッセージが出力され、sp_BlitzCacheの呼び出し開始を示す。

**期待されるアクション**：DBAはこのメッセージを確認することで、sp_BlitzCacheの実行が開始されたことを把握できる。sp_BlitzCacheの実行には時間がかかる場合があり、この通知以降に処理が長時間続く場合は、プランキャッシュの分析が進行中であることを意味する。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

SSMSのメッセージペインまたはSQLクライアントツールの標準出力に対して自動的に送信される。

## 通知テンプレート

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

| 項目 | 内容 |
|-----|------|
| メッセージレベル | 10（情報） |
| ステート | 1 |
| 形式 | テキスト |

### 本文テンプレート

```
Calling sp_BlitzCache
```

### 添付ファイル

なし

## テンプレート変数

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

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| ストアドプロシージャ実行 | sp_BlitzFirst実行 | @OutputTableNameBlitzCache IS NOT NULL AND @OutputDatabaseName IS NOT NULL AND @OutputSchemaName IS NOT NULL AND 出力データベースが存在 | すべての条件を満たす場合のみ出力 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| @OutputTableNameBlitzCache IS NULL | sp_BlitzCache出力テーブル名が未指定 |
| @OutputDatabaseName IS NULL | 出力データベース名が未指定 |
| @OutputSchemaName IS NULL | 出力スキーマ名が未指定 |
| 出力データベースが存在しない | sys.databasesに存在しない |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[分析完了結果出力] --> B{@OutputTableNameBlitzCache設定あり?}
    B -->|No| G[sp_BlitzCacheスキップ]
    B -->|Yes| C{@OutputDatabaseName設定あり?}
    C -->|No| G
    C -->|Yes| D{@OutputSchemaName設定あり?}
    D -->|No| G
    D -->|Yes| E{出力データベース存在?}
    E -->|No| G
    E -->|Yes| F[RAISERROR 'Calling sp_BlitzCache']
    F --> H{sp_BlitzCacheが新バージョン?}
    H -->|Yes| I[sp_BlitzCache実行（@MinutesBack付き）]
    H -->|No| J[sp_BlitzCache実行（基本パラメータ）]
    I --> K[履歴データ削除]
    J --> K
    G --> L[後続処理へ]
    K --> L
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| sys.databases | 出力データベースの存在確認 | @OutputDatabaseNameの検証 |
| sys.objects | sp_BlitzCacheの存在確認 | name = 'sp_BlitzCache' |
| sys.parameters | sp_BlitzCacheのパラメータ確認 | @MinutesBack, @CheckDateOverrideの有無 |

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

#### sys.objects / sys.parameters

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| object_id | オブジェクトID | name = 'sp_BlitzCache' |
| name (parameters) | パラメータ名 | @MinutesBack, @CheckDateOverride |

### 更新テーブル一覧

sp_BlitzCacheの実行により、指定されたテーブルにデータが出力される（sp_BlitzCache側で処理）。

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| @OutputTableNameBlitzCache | INSERT | sp_BlitzCacheの結果 |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| なし | RAISERRORは情報レベルのため、エラーは発生しない | - |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし

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

- sp_BlitzCacheの実行にはVIEW SERVER STATE権限が必要
- プランキャッシュの情報にはクエリテキストが含まれる
- この通知自体には機密情報は含まれない

## 備考

- sp_BlitzCacheの新バージョン（@MinutesBack, @CheckDateOverrideパラメータ対応）の場合、過去の実行からの経過時間を自動計算する
- @BlitzCacheMinutesBackが取得できない場合やNULL/1未満/60超の場合は、デフォルトで15分に設定される
- sp_BlitzCacheが存在しないか古いバージョンの場合、CheckID 36として警告が出力される

---

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

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

### 推奨読解順序

#### Step 1: 呼び出し条件を理解する

sp_BlitzCache呼び出しの前提条件を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | sp_BlitzFirst.sql | `sp_BlitzFirst.sql` | 行3796-3803（呼び出し条件のIF文） |

**読解のコツ**: 複数のパラメータがすべてNOT NULLであり、かつデータベースが存在することが必要。

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

通知が発行される箇所を特定する。

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

**主要処理フロー**:
1. **行3796-3803**: IF条件の確認
2. **行3806**: RAISERROR - sp_BlitzCache呼び出し開始通知
3. **行3809-3813**: sp_BlitzCacheの新バージョン確認

#### Step 3: sp_BlitzCache実行処理を理解する

sp_BlitzCacheの実行とパラメータ設定を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | sp_BlitzFirst.sql | `sp_BlitzFirst.sql` | 行3809-3813（パラメータ確認） |
| 3-2 | sp_BlitzFirst.sql | `sp_BlitzFirst.sql` | 行3815-3825（@BlitzCacheMinutesBack計算） |
| 3-3 | sp_BlitzFirst.sql | `sp_BlitzFirst.sql` | 行3833-3858（sp_BlitzCache実行） |

**主要処理フロー**:
- **行3809-3813**: @MinutesBack, @CheckDateOverrideパラメータの存在確認
- **行3815-3825**: 前回実行からの経過時間を計算
- **行3828-3829**: NULL/1未満/60超の場合は15分に設定
- **行3833-3858**: sp_BlitzCache実行（@OutputType別分岐）

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

```
sp_BlitzFirst
    |
    +-- 分析完了結果出力（行3793）
    |
    +-- IF @OutputTableNameBlitzCache IS NOT NULL
    |   AND @OutputDatabaseName IS NOT NULL
    |   AND @OutputSchemaName IS NOT NULL
    |   AND EXISTS (出力データベース)
            |
            +-- RAISERROR 'Calling sp_BlitzCache'（行3806）
            |
            +-- IF EXISTS (@MinutesBack, @CheckDateOverrideパラメータ)
            |       |
            |       +-- @BlitzCacheMinutesBack計算
            |       |
            |       +-- sp_BlitzCache実行
            |               |
            |               +-- @OutputDatabaseName
            |               +-- @OutputSchemaName
            |               +-- @OutputTableName
            |               +-- @SortOrder = 'all'
            |               +-- @MinutesBack
            |
            +-- ELSE
                    |
                    +-- CheckID 36: sp_BlitzCache未インストール警告
```

### データフロー図

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

@OutputTableNameBlitzCache --> IF条件判定 ---------------> 条件OK/NG
@OutputDatabaseName                |
@OutputSchemaName                  v
                              RAISERROR ---------------> クライアントへの
                                   |                    メッセージ表示
                                   v
sys.objects / parameters ---> バージョン確認
                                   |
                                   v
前回実行時刻 ---------------> @BlitzCacheMinutesBack計算
                                   |
                                   v
                              sp_BlitzCache実行
                                   |
                                   v
                              結果テーブル
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| sp_BlitzFirst.sql | `sp_BlitzFirst.sql` | ソース | メインストアドプロシージャ（行3796-3875） |
| sp_BlitzCache.sql | `sp_BlitzCache.sql` | ソース | sp_BlitzCacheストアドプロシージャ |
