# 通知設計書 19-スピルソート非対応

## 概要

本ドキュメントは、sp_BlitzCache ストアドプロシージャにおいて、SQLバージョンがスピルによるソートをサポートしていない場合に発生するエラー通知の設計書である。

### 本通知の処理概要

本通知は、クエリプランキャッシュ分析結果をスピルでソートしようとした際に、SQL Serverのバージョンがこの機能をサポートしていない場合にエラーを通知してプロシージャを終了する機能を提供する。

**業務上の目的・背景**：sp_BlitzCacheでは、スピル（spills）やその平均（avg spills）でクエリをソートする機能がある。スピルとは、クエリ実行時にメモリが不足し、データを一時的にtempdbにあふれさせる現象を指す。スピルが多いクエリはパフォーマンス問題の原因となるため、この情報でソートして問題クエリを特定することが重要である。しかし、この機能はSQL Serverの特定バージョン以降でのみ利用可能である。

**通知の送信タイミング**：sp_BlitzCache実行時のバージョン検証フェーズで、@SortOrderが'spills'または'avg spills'であり、かつ@VersionShowsSpillsフラグが0（非対応）の場合にエラーが発生する。

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

**通知内容の概要**：SQL Serverのバージョンがスピルによるソートをサポートしていないこと、別のソート順を使用するよう求めるエラーメッセージを含む。

**期待されるアクション**：受信者は、別のソート順（cpu, reads, duration等）を@SortOrderパラメータに指定してsp_BlitzCacheを再実行する。

## 通知種別

SQLメッセージ（RAISERROR）

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

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

| 項目 | 内容 |
|-----|------|
| Severity | 16 |
| State | 1 |
| WITH NOWAIT | なし |

### 本文テンプレート

```
Your version of SQL does not support sorting by spills. Please use another sort order.
```

### 添付ファイル

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

## テンプレート変数

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

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| プロシージャ実行 | sp_BlitzCache実行 | @SortOrder IN ('spills', 'avg spills') AND @VersionShowsSpills = 0 | バージョン検証フェーズで発生 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| @SortOrderがspills関連でない | スピルソート以外を指定した場合 |
| @VersionShowsSpills = 1 | 対応バージョンの場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[sp_BlitzCache実行] --> B[SQL Serverバージョン判定]
    B --> C[@VersionShowsSpills設定]
    C --> D{@SortOrder IN 'spills', 'avg spills'?}
    D -->|No| E[検証スキップ - 処理継続]
    D -->|Yes| F{@VersionShowsSpills = 0?}
    F -->|No| G[対応バージョン - 処理継続]
    F -->|Yes| H[RAISERROR発行]
    H --> I[RETURN - プロシージャ終了]
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| #checkversion | バージョン情報の一時格納 | 一時テーブル |

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

#### #checkversion

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| common_version | SQL Serverのメジャーバージョン | SERVERPROPERTY('ProductVersion')から算出 |
| build | ビルド番号 | - |

### 更新テーブル一覧

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

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| スピルソート非対応 | 古いSQL Serverバージョンでspillsソートを指定 | 別のソート順を使用 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし

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

- システム関数とパラメータ比較のみで、外部入力のバリデーションではないためセキュリティリスクはない

## 備考

- スピル情報は、sys.dm_exec_query_statsのtotal_spills列等から取得される
- SQL Server 2016 SP1以降でサポート
- このエラーが発生した場合、sp_BlitzCacheはRETURNで即座に終了する
- メモリグラントソート非対応（No.18）と同様のパターンで、対象が異なる

---

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

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

### 推奨読解順序

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

sp_BlitzCacheのパラメータ定義と、バージョン関連の変数を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | sp_BlitzCache.sql | `sp_BlitzCache.sql` | @VersionShowsSpills変数の定義と設定 |

**読解のコツ**: @VersionShowsSpillsがどの条件で1に設定されるかを確認する。

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

バージョン検証ロジックの開始点を特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | sp_BlitzCache.sql | `sp_BlitzCache.sql` | 行1958-1962付近のスピルソート検証部分 |

**主要処理フロー**:
1. **行1958**: IF (@SortOrder IN ('spills', 'avg spills') AND @VersionShowsSpills = 0)
2. **行1960**: RAISERRORによるエラーメッセージ発行
3. **行1961**: RETURNによるプロシージャ終了

#### Step 3: バージョン判定ロジックを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | sp_BlitzCache.sql | `sp_BlitzCache.sql` | @VersionShowsSpillsの設定箇所 |

**主要処理フロー**:
- common_versionとbuildに基づいてフラグが設定される

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

```
sp_BlitzCache
    |
    +-- パラメータ検証フェーズ（完了）
    |
    +-- バージョン判定フェーズ
    |      |
    |      +-- SERVERPROPERTY('ProductVersion') 取得
    |      |
    |      +-- #checkversion テーブル作成・挿入
    |      |
    |      +-- @v, @build 取得
    |      |
    |      +-- @VersionShowsSpills 設定
    |
    +-- メモリグラントソート検証（No.18）
    |
    +-- スピルソート検証フェーズ
    |      |
    |      +-- IF @SortOrder IN ('spills', 'avg spills')
    |             AND @VersionShowsSpills = 0
    |             |
    |             +-- RAISERROR 'Your version of SQL does not support...'
    |             |
    |             +-- RETURN
    |
    +-- 関数フィルタ検証（No.20）
    |
    +-- 分析実行フェーズ（本エラー時は到達しない）
```

### データフロー図

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

@SortOrder ──────────> バージョン判定 ──────────> 対応検証 ──────────> エラーメッセージ
                       |                          |                    |
                       v                          v                    v
               ProductVersion取得          @VersionShows           RAISERROR
               #checkversion挿入          Spills判定              (Severity 16)
                       |                          |
                       v                          v
                  @v, @build取得              = 0 の場合
                                                  |
                                                  v
                                               RETURN
```

### 関連ファイル一覧

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