# 通知設計書 77-クエリハッシュソート開始

## 概要

本ドキュメントは、SQL Server First Responder Kitのsp_BlitzCacheプロシージャにおいて、クエリハッシュによるソート処理を開始した際に出力される情報通知「クエリハッシュソート開始」について定義する。

### 本通知の処理概要

本通知は、sp_BlitzCacheストアドプロシージャ内で、@SortOrderパラメータに「query hash」が指定された場合に、クエリハッシュベースのソート処理を開始したことをユーザーに通知するための情報メッセージである。

**業務上の目的・背景**：sp_BlitzCacheは、プランキャッシュ内のクエリを分析し、パフォーマンス問題を特定するプロシージャである。同一のクエリハッシュを持つ複数のプランが存在する場合、それらをグループ化して分析することで、パラメータスニッフィングや同一クエリの複数プラン問題を検出できる。この通知は、クエリハッシュベースの特別な分析処理が開始されたことを管理者に知らせる。

**通知の送信タイミング**：sp_BlitzCacheプロシージャの初期化フェーズにおいて、@SortOrderが'query hash'で始まる場合に、クエリハッシュのグループ化処理を開始する直前に送信される。具体的にはsp_BlitzCache.sqlの行1018で出力される。

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

**通知内容の概要**：「Beginning query hash sort」という固定メッセージが出力される。これにより、クエリハッシュベースのソート処理が開始されたことが明確に示される。

**期待されるアクション**：この通知は情報提供目的であり、特別なアクションは不要。クエリハッシュソートは追加的な処理時間を要する可能性があるため、管理者は処理が進行中であることを確認できる。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

実行中のセッションのクライアント（SSMSのメッセージタブ等）に対して直接出力される。@SortOrder LIKE 'query hash%'の条件を満たす場合のみ出力。

## 通知テンプレート

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

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

### 本文テンプレート

```
Beginning query hash sort
```

### 添付ファイル

なし

## テンプレート変数

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

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| プロシージャ内部処理 | クエリハッシュソート開始 | @SortOrder LIKE 'query hash%' | @SortOrderが'query hash'で始まる場合 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| @SortOrder NOT LIKE 'query hash%' | クエリハッシュソートが指定されていない場合は出力されない |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[sp_BlitzCache開始] --> B[パラメータ検証]
    B --> C{@SortOrder LIKE 'query hash%'?}
    C -->|Yes| D["RAISERROR('Beginning query hash sort',0,1) WITH NOWAIT"]
    C -->|No| E[通常ソート処理]
    D --> F[#query_hash_grouped一時テーブル作成]
    F --> G[クエリハッシュでグループ化]
    G --> H[@OnlyQueryHashes設定]
    H --> I[@SortOrder調整]
    I --> J[メイン処理へ]
    E --> J
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| sys.dm_exec_query_stats | クエリ統計の取得 | query_hash でグループ化 |
| sys.dm_exec_plan_attributes | プラン属性の取得 | dbid取得用 |

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

#### sys.dm_exec_query_stats
| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| query_hash | クエリハッシュ値 | グループ化キー |
| max_worker_time | 最大ワーカー時間 | ソート基準 |
| plan_handle | プランハンドル | プラン属性取得用 |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| #query_hash_grouped | CREATE/INSERT | クエリハッシュでグループ化した結果を格納 |

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし（sp_BlitzCache実行時、query hashソート指定時に出力）

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

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

## 備考

- WITH NOWAIT指定により、バッファリングされずに即時クライアントに送信される
- クエリハッシュソートは、同一クエリの複数プラン問題を分析する際に有用
- @SortOrderは'query hash'の後に別のソート基準を続けることができる（例：'query hash, cpu'）
- 類似の通知として「Beginning duplicate query hash sort」も存在する（行1052）

---

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

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

### 推奨読解順序

#### Step 1: ソートオプションを理解する

@SortOrderパラメータの動作を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | sp_BlitzCache.sql | `sp_BlitzCache.sql` | パラメータ宣言部分で@SortOrderの定義を確認 |

**読解のコツ**: @SortOrderに指定可能な値（cpu, reads, writes, duration, query hashなど）を確認する。

#### Step 2: クエリハッシュソート処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | sp_BlitzCache.sql | `sp_BlitzCache.sql` | 行1016-1046のクエリハッシュソート処理 |

**主要処理フロー**:
1. **行1016**: `IF @SortOrder LIKE 'query hash%'`
2. **行1018**: `RAISERROR('Beginning query hash sort', 0, 1) WITH NOWAIT;`
3. **行1020-1031**: #query_hash_groupedテーブルへのSELECT INTO
4. **行1033-1038**: @OnlyQueryHashesの設定
5. **行1041**: @SortOrderからquery hashを除去
6. **行1044**: デフォルトの'cpu'ソートへフォールバック

#### Step 3: グループ化ロジックを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | sp_BlitzCache.sql | `sp_BlitzCache.sql` | 行1020-1031のSELECT INTO文 |

**主要処理フロー**:
- **行1020-1031**:
  - sys.dm_exec_query_stats から query_hash でグループ化
  - HAVING COUNT_BIG(*) > 1 で複数プランを持つもののみ抽出
  - max_worker_time DESC でソート

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

```
sp_BlitzCache（エントリーポイント）
    │
    ├─ パラメータ検証
    │
    ├─ @SortOrder LIKE 'query hash%' 判定
    │      │
    │      ├─ Yes: RAISERROR('Beginning query hash sort') ← 本通知
    │      │        │
    │      │        ├─ SELECT INTO #query_hash_grouped
    │      │        │      └─ sys.dm_exec_query_stats JOIN sys.dm_exec_plan_attributes
    │      │        │
    │      │        ├─ @OnlyQueryHashes 設定
    │      │        │
    │      │        └─ @SortOrder 調整
    │      │
    │      └─ No: 通常処理へ
    │
    └─ メイン分析処理
```

### データフロー図

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

@SortOrder = 'query hash'     ───▶ クエリハッシュソート     ───▶ クライアントメッセージ
                                      │                                 「Beginning query hash sort」
                                      │
sys.dm_exec_query_stats       ───▶ グループ化処理           ───▶ #query_hash_grouped
sys.dm_exec_plan_attributes         │
                                      │
                                      └─ @OnlyQueryHashes   ───▶ カンマ区切りハッシュリスト
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| sp_BlitzCache.sql | `sp_BlitzCache.sql` | ソース | メインプロシージャ。クエリハッシュソート開始通知を出力（行1018） |
| Install-All-Scripts.sql | `Install-All-Scripts.sql` | インストール | 全スクリプトを含むインストールファイル（行14174） |
| Install-Azure.sql | `Install-Azure.sql` | インストール | Azure向けインストールファイル（行1909） |
