# 通知設計書 110-BlitzCache取得

## 概要

本ドキュメントは、SQL Server First Responder Kit の sp_BlitzAnalysis プロシージャにおける「BlitzCache取得」情報通知の設計を定義する。

### 本通知の処理概要

この通知は、sp_BlitzAnalysis プロシージャがBlitzCacheの過去データを取得・分析する際に出力される情報メッセージである。

**業務上の目的・背景**：SQL Server のパフォーマンス分析において、プランキャッシュに格納されたクエリの実行統計は最も重要な情報の一つである。sp_BlitzCache によって収集されたクエリ統計データを分析することで、リソースを最も消費しているクエリや、改善が必要なクエリを特定できる。この通知により、DBAはBlitzCacheデータの取得が開始されたことを確認でき、分析処理の進行状況を監視できる。

**通知の送信タイミング**：sp_BlitzAnalysis の実行中、BlitzCache データの取得クエリが実行される直前に出力される。テーブルが存在し、パラメータで指定されている場合に出力される。

**通知の受信者**：sp_BlitzAnalysis プロシージャを実行しているDBA、またはSQL Server Management Studio (SSMS) のクエリウィンドウで結果を監視しているオペレーター。

**通知内容の概要**：「Getting BlitzCache info from {テーブル名}」というメッセージが出力され、どのテーブルからBlitzCacheデータを取得しているかを示す。

**期待されるアクション**：通知を受け取った受信者は、BlitzCacheデータの取得が開始されたことを確認する。結果にはCPU、読み取り、書き込み、実行時間などでソートされた上位クエリが含まれる。

## 通知種別

RAISERROR によるメッセージ出力（SQL Server メッセージ / SSMS メッセージタブ）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（RAISERROR WITH NOWAIT） |
| 優先度 | 情報（Severity 0） |
| リトライ | なし |

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

本通知はクライアント接続に対して直接送信される。sp_BlitzAnalysis を実行しているセッションのクライアントが受信者となる。

## 通知テンプレート

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

| 項目 | 内容 |
|-----|------|
| メッセージ形式 | プレーンテキスト |
| 重大度 | 0（情報） |
| 状態 | 0 |

### 本文テンプレート

```
Getting BlitzCache info from %s
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| %s | 完全修飾テーブル名 | @FullOutputTableNameBlitzCache 変数 | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| プロシージャ実行 | BlitzCache データ取得前 | @OutputTableNameBlitzCache IS NOT NULL | BlitzCache テーブルからのデータ取得開始 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| @OutputTableNameBlitzCache IS NULL | BlitzCache テーブル名が指定されていない |
| OBJECT_ID(@FullOutputTableNameBlitzCache) IS NULL | テーブルが存在しない（別メッセージを出力） |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[Perfmon 処理完了] --> B[BlitzCache SQL 構築]
    B --> C[RAISERROR 'Getting BlitzCache info from %s']
    C --> D{@Debug = 1?}
    D -->|Yes| E[SQL文出力]
    D -->|No| F{テーブル存在?}
    E --> F
    F -->|No| G[テーブル不存在メッセージ]
    F -->|Yes| H[sp_executesql 実行]
    H --> I[結果返却]
    G --> J[次の処理へ]
    I --> J
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| {OutputDatabaseName}.{OutputSchemaName}.{OutputTableNameBlitzCache} | BlitzCache のクエリ統計データ | sp_BlitzCache が出力 |

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

#### BlitzCache テーブル

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| ServerName | サーバー名 | = @Servername |
| CheckDate | チェック日時 | BETWEEN @StartDate AND @EndDate |
| DatabaseName | データベース名 | オプションフィルタ |
| QueryType | クエリタイプ | 結果出力用 |
| QueryText | クエリテキスト | 結果出力用 |
| TotalCPU | 合計CPU時間 | ソート基準（cpu） |
| TotalReads | 合計読み取り | ソート基準（reads） |
| TotalWrites | 合計書き込み | ソート基準（writes） |
| TotalDuration | 合計実行時間 | ソート基準（duration） |
| ExecutionCount | 実行回数 | ソート基準（executions） |
| MaxGrantKB | 最大メモリ付与KB | ソート基準（memory grant） |
| MaxSpills | 最大スピル | ソート基準（spills） |
| QueryPlan | クエリプラン | 結果出力用 |

### 更新テーブル一覧

なし（参照のみ）

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| テーブル不存在 | 指定されたテーブルが存在しない | エラーメッセージを出力して次の処理へ |
| 権限不足 | テーブルへの SELECT 権限がない | 適切な権限を付与 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし

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

- BlitzCache テーブルへの SELECT 権限が必要
- クエリテキストやクエリプランには機密情報が含まれる可能性がある
- @Debug = 1 の場合、実行されるクエリが出力される

## 備考

- @BlitzCacheSortorder パラメータでソート順を制御可能（cpu, reads, writes, duration, executions, memory grant, spills, all）
- @BlitzCacheSortorder = 'all' の場合、すべてのソート順でデータを取得（時間がかかる）
- 複雑なCTE（共通テーブル式）を使用してソート順ごとにデータを取得
- 各ソート順で上位5件のクエリを取得

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | sp_BlitzAnalysis.sql | `sp_BlitzAnalysis.sql` | 81行目で @FullOutputTableNameBlitzCache 変数の定義を確認 |
| 1-2 | sp_BlitzAnalysis.sql | `sp_BlitzAnalysis.sql` | 100行目でテーブル名の構築を確認 |
| 1-3 | sp_BlitzAnalysis.sql | `sp_BlitzAnalysis.sql` | 24行目で @BlitzCacheSortorder パラメータの定義を確認 |

**読解のコツ**: BlitzCache の取得は他のテーブルと異なり、複雑なCTE構造を使用して複数のソート順でデータを取得する。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | sp_BlitzAnalysis.sql | `sp_BlitzAnalysis.sql` | 492-743行目で BlitzCache データ取得処理全体を確認 |
| 2-2 | sp_BlitzAnalysis.sql | `sp_BlitzAnalysis.sql` | 704行目で本通知の出力箇所を確認 |

**主要処理フロー**:
1. **493行目**: `RAISERROR('Sortorder for BlitzCache data: %s')` - ソート順の情報出力
2. **496-509行目**: 初期CTE（CheckDates）の構築
3. **514-663行目**: ソート順ごとのCTE構築（VALUES句とXML PATH）
4. **668-691行目**: SELECT 文の構築（UNION ALL）
5. **704行目**: `RAISERROR('Getting BlitzCache info from %s')` - 本通知の出力
6. **717-743行目**: テーブル存在チェックとクエリ実行

#### Step 3: 動的SQLの構築を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | sp_BlitzAnalysis.sql | `sp_BlitzAnalysis.sql` | 514-663行目でCTEの動的構築 |
| 3-2 | sp_BlitzAnalysis.sql | `sp_BlitzAnalysis.sql` | 648-656行目でソートオプションのVALUES句 |

**主要処理フロー**:
- **648-656行目**: VALUES句で7種類のソートオプションを定義
- **657-662行目**: @BlitzCacheSortorder と @IncludeMemoryGrants, @IncludeSpills によるフィルタ

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

```
sp_BlitzAnalysis
    │
    ├─ Perfmon 処理
    │
    ├─ ソート順情報出力
    │      └─ RAISERROR('Sortorder for BlitzCache data: %s')
    │
    ├─ テーブル名構築
    │      └─ @FullOutputTableNameBlitzCache
    │
    ├─ 動的SQL構築（複雑なCTE）
    │      ├─ CheckDates CTE
    │      ├─ TopCPU CTE
    │      ├─ TopReads CTE
    │      ├─ TopWrites CTE
    │      ├─ TopDuration CTE
    │      ├─ TopExecutions CTE
    │      ├─ TopMemoryGrants CTE
    │      └─ TopSpills CTE
    │
    ├─ RAISERROR('Getting BlitzCache info from %s')
    │      └─ 本通知の出力
    │
    ├─ OBJECT_ID チェック
    │      └─ テーブル存在確認
    │
    └─ sp_executesql
           └─ 動的SQL実行
```

### データフロー図

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

@OutputTableNameBlitzCache ─▶ テーブル名構築 ────────────▶ 完全修飾テーブル名
                               │
@BlitzCacheSortorder ─────────▶ ソート順判定 ────────────▶ CTE選択
                               │
@IncludeMemoryGrants ─────────▶ 機能判定 ────────────────▶ CTE条件
@IncludeSpills ───────────────▶    │
                               │
@StartDate ───────────────────▶ 期間フィルタ ───────────▶ CheckDate 条件
@EndDate ─────────────────────▶    │
                               │
@Databasename ────────────────▶ DBフィルタ ─────────────▶ DatabaseName 条件
                               │
                               ▼
                         RAISERROR ──────────────────────▶ 'Getting BlitzCache info from %s'
                               │                           (メッセージ出力)
                               ▼
                    OBJECT_ID チェック ──────────────────▶ (存在確認)
                               │
                               ▼
                    sp_executesql ───────────────────────▶ 結果セット
                               │                           (クエリ統計 - 複数ソート順)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| sp_BlitzAnalysis.sql | `sp_BlitzAnalysis.sql` | ソース | 本通知を発行するストアドプロシージャ本体 |
| BlitzCache | ユーザー指定 | 参照テーブル | sp_BlitzCache のクエリ統計データを格納 |
