# 通知設計書 83-テーブル変数チェック

## 概要

本ドキュメントは、SQL Server First Responder Kitのsp_BlitzCache.sqlにおける「テーブル変数チェック」通知の設計を定義する。この通知は、クエリプランキャッシュの分析中にテーブル変数の使用を検出するチェック処理の開始を示す情報メッセージである。

### 本通知の処理概要

この通知は、sp_BlitzCacheストアドプロシージャがキャッシュされた実行プランを分析する際に、XMLクエリプラン内でテーブル変数（@で始まるオブジェクト名）の使用を検出するチェック処理の開始を示す。

**業務上の目的・背景**：テーブル変数はSQL Serverにおいてパフォーマンス問題を引き起こす可能性がある構造である。テーブル変数は統計情報を持たないため、クエリオプティマイザは常に1行と見積もり、実際の行数が多い場合にサブオプティマルな実行プランが選択される。この問題を検出することで、一時テーブル（#temp）への変更や、OPTION (RECOMPILE)の追加などの対策を検討できる。

**通知の送信タイミング**：sp_BlitzCacheプロシージャの実行中、演算子レベルのチェック（busy loops、TVF join等）が完了した後、テーブル変数チェック処理が開始される直前のタイミングで送信される。具体的には、XMLクエリプラン内のObject要素のTable属性が@で始まるかを確認するUPDATE文の実行直前である。

**通知の受信者**：この通知はRAISERROR関数によりSQL Server Management Studio（SSMS）のメッセージウィンドウ、またはsqlcmdなどのコマンドラインツールの標準出力に表示される。主な受信者は、sp_BlitzCacheを実行しているDBA、データベース開発者、システム管理者である。

**通知内容の概要**：「Checking for table variables」という英語メッセージが表示され、現在テーブル変数のチェック処理を実行中であることを示す。これにより、長時間実行される分析処理の進捗状況を把握できる。

**期待されるアクション**：通知の受信者は、処理が正常に進行していることを確認し、処理完了を待つ。分析結果においてテーブル変数が検出された場合は、そのテーブル変数に多数の行が格納される可能性があるかを確認し、必要に応じて一時テーブルへの変更やOPTION (RECOMPILE)の追加を検討する。

## 通知種別

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

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（WITH NOWAITオプションにより即座に出力） |
| 優先度 | 低（情報レベル、重大度0） |
| リトライ | なし（単発の情報メッセージ） |

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

sp_BlitzCacheを実行しているセッションのクライアント接続に対して直接出力される。送信先の動的な決定ロジックは存在せず、実行元のセッションに対して常に通知される。

## 通知テンプレート

### メール通知の場合

該当なし（コンソール出力のみ）

### 本文テンプレート

```
Checking for table variables
```

### 添付ファイル

該当なし

## テンプレート変数

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

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| プロシージャ実行 | sp_BlitzCache内のテーブル変数チェック処理開始 | 常に送信（条件なし） | テーブル変数チェック処理の開始時に必ず通知 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| なし | このメッセージは常に出力される |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[演算子警告チェック完了] --> B[RAISERROR実行]
    B --> C[メッセージ即時出力]
    C --> D[is_table_variableフラグ更新処理]
    D --> E[XMLクエリプラン解析]
    E --> F[Object/@Table属性取得]
    F --> G{2文字目が@か?}
    G -->|Yes| H[##BlitzCacheProcs更新]
    G -->|No| I[スキップ]
    H --> J[次のチェック処理へ]
    I --> J
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| ##BlitzCacheProcs | プランキャッシュ分析結果の格納 | グローバル一時テーブル |
| #relop | RelOp要素のXMLを一時格納 | ローカル一時テーブル |

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

#### ##BlitzCacheProcs

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| SqlHandle | クエリプランの結合キー | WHERE SPID = @@SPID |
| is_table_variable | テーブル変数フラグの更新対象 | SET句で1に更新 |

#### #relop

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| SqlHandle | 結合キー | ##BlitzCacheProcsとの結合 |
| relop | XMLプランの解析 | nodes()関数でObject要素を抽出 |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| ##BlitzCacheProcs | UPDATE | is_table_variableカラムを1に設定 |

#### ##BlitzCacheProcs更新

| 操作 | 項目（カラム名） | 更新値 | 備考 |
|-----|-----------------|-------|------|
| UPDATE | is_table_variable | 1 | テーブル変数が存在する場合のみ |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| XMLパースエラー | 不正なXMLフォーマット | エラーは発生しにくいが、存在チェックのみのため影響なし |
| メモリ不足 | 大量のプラン処理時 | @Topパラメータで対象を制限 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし（sp_BlitzCache実行時に即座に出力）

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

- 通知内容に機密情報は含まれない
- VIEW SERVER STATE権限が必要（sp_BlitzCache実行の前提条件）

## 備考

- この通知はsp_BlitzCacheの進捗表示の一部であり、長時間実行時のユーザーへのフィードバックとして機能する
- WITH NOWAITオプションにより、バッファリングなしで即座にクライアントに送信される
- 重大度0は情報メッセージを意味し、エラーではない
- テーブル変数の検出は、Table属性の2文字目が@かどうかで判定される（substring(@Table, 2, 1)）
- これはSQL Serverの内部表現で、テーブル変数名が`[@variable]`のような形式で格納されるため

---

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

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

### 推奨読解順序

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

まず、プロシージャで使用される一時テーブルの構造を把握する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | sp_BlitzCache.sql | `sp_BlitzCache.sql` | ##BlitzCacheProcsテーブルのis_table_variableカラム定義を確認 |
| 1-2 | sp_BlitzCache.sql | `sp_BlitzCache.sql` | #relopテーブルの構造を確認 |

**読解のコツ**: #relopテーブルにはRelOp要素のXMLが格納されており、CROSS APPLYでObject要素を展開している。

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

処理の起点となるストアドプロシージャの構造を把握する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | sp_BlitzCache.sql | `sp_BlitzCache.sql` | 演算子警告チェックとテーブル変数チェックの連続した処理フロー |

**主要処理フロー**:
1. **行3455**: RAISERROR(N'Checking for table variables', 0, 1) WITH NOWAITでメッセージ出力
2. **行3456-3469**: XMLNAMESPACESとCTEを使用したテーブル変数チェックのUPDATE文実行

#### Step 3: XMLプラン解析処理を理解する

テーブル変数チェックの実際のロジックを把握する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | sp_BlitzCache.sql | `sp_BlitzCache.sql` | CTEとCROSS APPLYによるObject要素の展開、substring関数による文字判定 |

**主要処理フロー**:
- **行3456**: XMLネームスペースの定義（showplanスキーマ）
- **行3459**: `c.n.value('substring(@Table, 2, 1)','VARCHAR(100)')` でTable属性の2文字目を取得
- **行3468**: `WHERE x.first_char = '@'` でテーブル変数を判定

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

```
sp_BlitzCache
    |
    +-- RAISERROR('Checking for operator warnings')
    |       |
    |       +-- [operator warnings更新処理]
    |
    +-- RAISERROR('Checking for table variables')  <-- 本通知
    |       |
    |       +-- WITH x AS (CTE定義)
    |       |       |
    |       |       +-- #relop との結合
    |       |       |
    |       |       +-- nodes('//p:Object') でObject要素展開
    |       |       |
    |       |       +-- substring(@Table, 2, 1) で2文字目取得
    |       |
    |       +-- UPDATE ##BlitzCacheProcs SET is_table_variable = 1
    |               |
    |               +-- WHERE x.first_char = '@'
    |
    +-- [後続処理] Checking for functions
```

### データフロー図

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

#relop.relop            --> XMLネームスペース解析                --> ##BlitzCacheProcs.is_table_variable
(XMLクエリプラン)           nodes('//p:Object')                       (1 = テーブル変数あり)
                               |
                               v
                           value('substring(@Table, 2, 1)')
                               |
                               v
                           first_char = '@' 判定
                               |
                               v
                           コンソール出力 <-- RAISERROR
                           "Checking for table variables"
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| sp_BlitzCache.sql | `sp_BlitzCache.sql` | ソース | テーブル変数チェック処理を含むメインストアドプロシージャ |
