# 通知設計書 75-結果返却

## 概要

本ドキュメントは、SQL Server First Responder Kitのsp_BlitzIndexプロシージャにおいて、分析結果の返却を開始した際に出力される情報通知「結果返却」について定義する。

### 本通知の処理概要

本通知は、sp_BlitzIndexストアドプロシージャ内で、すべてのインデックス分析処理が完了し、結果をクライアントまたは出力テーブルに返却する段階に入ったことをユーザーに通知するための情報メッセージである。

**業務上の目的・背景**：sp_BlitzIndexは、複数のデータベースを対象にインデックス構成を診断し、問題点や改善提案を収集する。すべての分析処理が完了した後、収集した結果をクライアントに返すか、指定された出力テーブルに格納する必要がある。この通知は、分析フェーズが完了し、結果出力フェーズに移行したことを管理者に知らせる。

**通知の送信タイミング**：sp_BlitzIndexプロシージャの最終フェーズにおいて、すべてのデータベースの分析が完了し、結果を返却する直前に送信される。具体的にはsp_BlitzIndex.sqlの行5928で出力される。

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

**通知内容の概要**：「Returning results.」という固定メッセージが出力される。これにより、分析が完了し結果出力段階に入ったことが明確に示される。

**期待されるアクション**：この通知は情報提供目的であり、特別なアクションは不要。管理者は分析処理が正常に完了し、間もなく結果が表示されることを認識できる。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

実行中のセッションのクライアント（SSMSのメッセージタブ等）に対して直接出力される。特定の宛先決定ロジックは存在しない。

## 通知テンプレート

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

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

### 本文テンプレート

```
Returning results.
```

### 添付ファイル

なし

## テンプレート変数

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

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| プロシージャ内部処理 | 結果返却開始 | 分析処理完了後 | すべてのデータベース分析が完了し、結果出力を開始する直前 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| なし | sp_BlitzIndex実行時は常に出力される |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[sp_BlitzIndex開始] --> B[一時テーブル作成]
    B --> C[データベースループ処理]
    C --> D[各種チェック実行]
    D --> E[デバッグモードの結果出力]
    E --> F["RAISERROR('Returning results.',0,1) WITH NOWAIT"]
    F --> G{出力先テーブル指定あり?}
    G -->|Yes| H[出力テーブル作成/更新]
    G -->|No| I[SELECTで直接結果返却]
    H --> J[結果INSERT]
    I --> K[処理完了]
    J --> K
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| #BlitzIndexResults | 分析結果の取得 | 最終結果として返却 |

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

#### #BlitzIndexResults
| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| Priority | 結果の優先度 | - |
| finding | 発見事項 | - |
| database_name | データベース名 | - |
| details | 詳細情報 | - |
| index_definition | インデックス定義 | - |
| url | 参考URL | - |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| 出力テーブル（指定時） | INSERT | @OutputTableNameが指定された場合、結果を永続テーブルに格納 |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| スキーマ名無効 | @OutputSchemaNameが無効な場合 | エラーメッセージ出力後、RETURN |
| テーブル作成失敗 | 出力テーブルの作成に失敗した場合 | エラーメッセージ出力後、RETURN |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし（sp_BlitzIndex実行時に常に出力）

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

- 本通知は固定の情報メッセージであり、機密情報を含まない
- 出力テーブルへの書き込みには適切な権限が必要

## 備考

- WITH NOWAIT指定により、バッファリングされずに即時クライアントに送信される
- @ValidOutputLocation = 1の場合、出力テーブルへの格納処理が実行される
- リンクサーバーへの出力もサポートされている（@OutputServerName指定時）

---

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

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

### 推奨読解順序

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

結果格納先の一時テーブル構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | sp_BlitzIndex.sql | `sp_BlitzIndex.sql` | 行366-384の#BlitzIndexResultsテーブル定義 |

**読解のコツ**: 結果テーブルの各カラムが最終出力にどのようにマッピングされるかを理解する。

#### Step 2: 結果返却処理の全体像を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | sp_BlitzIndex.sql | `sp_BlitzIndex.sql` | 行5928-5990付近の結果返却ロジック |

**主要処理フロー**:
1. **行5923-5926**: デバッグモード時の結果出力
2. **行5928**: `RAISERROR(N'Returning results.', 0,1) WITH NOWAIT;`
3. **行5931-5937**: 出力先の有効性チェック
4. **行5939-5977**: 出力テーブルが存在しない場合の作成処理

#### Step 3: 結果出力パターンを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | sp_BlitzIndex.sql | `sp_BlitzIndex.sql` | 行5989-6050付近の INSERT/SELECT 処理 |

**主要処理フロー**:
- **行5989-6000**: 出力テーブルへのINSERTクエリ構築
- **@ValidOutputServer = 1**: リンクサーバー経由での実行
- **else**: 直接実行

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

```
sp_BlitzIndex（エントリーポイント）
    │
    ├─ 初期化・一時テーブル作成
    │
    ├─ データベースループ処理
    │      └─ 各種チェック・分析
    │
    ├─ デバッグ結果出力（@Debug=1時）
    │
    ├─ RAISERROR('Returning results.') ← 本通知
    │
    └─ 結果出力
           ├─ 出力テーブル指定あり → CREATE TABLE（必要時）→ INSERT
           │
           └─ 出力テーブル指定なし → SELECT結果返却
```

### データフロー図

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

#BlitzIndexResults       ───▶ 結果返却処理             ───▶ クライアントメッセージ
  │                             │                                 「Returning results.」
  │                             │
  │                             ├─ 出力テーブル作成
  │                             │
  └──────────────────────────▶ INSERT/SELECT           ───▶ 分析結果（テーブル/結果セット）
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| sp_BlitzIndex.sql | `sp_BlitzIndex.sql` | ソース | メインプロシージャ。結果返却通知を出力（行5928） |
| Install-All-Scripts.sql | `Install-All-Scripts.sql` | インストール | 全スクリプトを含むインストールファイル（行27251） |
| Install-Azure.sql | `Install-Azure.sql` | インストール | Azure向けインストールファイル（行20156） |
| Deprecated/sp_BlitzIndex_SQL_Server_2005.sql | `Deprecated/sp_BlitzIndex_SQL_Server_2005.sql` | 旧バージョン | SQL Server 2005向け旧バージョン（行2545） |
