# 通知設計書 42-大量データ警告

## 概要

本ドキュメントは、sp_BlitzAnalysisストアドプロシージャにおいて、4時間以上のデータを@BlitzCacheSortorder='all'でクエリしようとした場合に発生する警告通知の設計を記載する。

### 本通知の処理概要

本通知は、sp_BlitzAnalysisで大量のデータを分析しようとする際に、パフォーマンスへの影響を警告し、ユーザーに明示的な確認（@BringThePain = 1）を求める機能を提供する。

**業務上の目的・背景**：sp_BlitzAnalysisは診断データの時系列分析を行うストアドプロシージャであり、特に@BlitzCacheSortorder='all'オプションは複数のソート基準でデータを処理するため、処理負荷が高い。4時間以上の範囲でこのオプションを使用すると、SQL Serverに大きな負荷がかかり、本番環境のパフォーマンスに影響を与える可能性がある。このため、ユーザーに事前警告を行い、意図的な操作であることを確認する仕組みが必要である。

**通知の送信タイミング**：sp_BlitzAnalysisプロシージャの実行開始後、パラメータ検証フェーズにおいて以下の3条件がすべて満たされた場合に送信される：(1) @BlitzCacheSortorder = 'all'、(2) @StartDateと@EndDateの差が4時間を超える、(3) @BringThePain = 0（デフォルト）。

**通知の受信者**：sp_BlitzAnalysisを実行したSQL Serverクライアントセッション。RAISERRORステートメントによりクライアントに直接警告メッセージが返される。

**通知内容の概要**：警告メッセージには、大量データのクエリを実行しようとしていることの確認と、処理を続行するには@BringThePain = 1を設定する必要があることが含まれる。

**期待されるアクション**：ユーザーは通知内容を確認し、大量データ処理が本当に必要であれば@BringThePain = 1を指定して再実行する。不要であれば時間範囲を狭めるか、@BlitzCacheSortorderを特定のオプション（'cpu'など）に変更する。

## 通知種別

RAISERRORによるSQL Server警告メッセージ（クライアント通知）

## 送信仕様

### 基本情報

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

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

sp_BlitzAnalysisを実行したクライアントセッションに対して、RAISERRORステートメントにより直接警告メッセージを送信する。WITH NOWAITオプションにより即座にメッセージが送信される。

## 通知テンプレート

### 警告メッセージ

| 項目 | 内容 |
|-----|------|
| メッセージレベル | 11 |
| 状態 | 1 |
| 形式 | テキスト |

### 本文テンプレート

```
Wow! hold up now, are you sure you wanna do this? Are sure you want to query over 4 hours of data with @BlitzCacheSortorder set to 'all'? IF you do then set @BringThePain = 1 but I gotta warn you this might hurt a bit!
```

### 添付ファイル

なし

## テンプレート変数

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

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| プロシージャ実行 | sp_BlitzAnalysis実行 | @BlitzCacheSortorder='all' AND DATEDIFF(HOUR,@StartDate,@EndDate) > 4 AND @BringThePain = 0 | パラメータ検証フェーズで検出 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| @BringThePain = 1 | ユーザーが明示的にリスクを承認している場合 |
| @BlitzCacheSortorder != 'all' | 'all'以外のソートオプションの場合は大量処理にならない |
| 時間範囲が4時間以下 | 処理量が許容範囲内 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[sp_BlitzAnalysis実行開始] --> B[日付パラメータ設定]
    B --> C{@BlitzCacheSortorder = 'all'?}
    C -->|No| D[検証スキップ、処理継続]
    C -->|Yes| E{DATEDIFF HOUR > 4?}
    E -->|No| D
    E -->|Yes| F{@BringThePain = 0?}
    F -->|No| D
    F -->|Yes| G[RAISERROR実行]
    G --> H[RETURN - 処理中断]
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| なし | パラメータ検証のみのためテーブル参照なし | - |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| なし | なし | エラー発生時は即座にRETURNするため更新なし |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 大量データ警告 | @BlitzCacheSortorder='all'かつ4時間超かつ@BringThePain=0 | 警告メッセージを出力し処理中断 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし（プロシージャ実行時に即時送信）

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

- パラメータ値のみを検証するため、個人情報の漏洩リスクはない
- 警告メッセージにはシステム内部情報は含まれない
- @BringThePainフラグによりユーザーの意図的な操作を確認

## 備考

- この警告は、SQL Serverのパフォーマンスを保護するための安全機能である
- @BringThePain = 1を設定することで、ユーザーは処理負荷のリスクを承知の上で実行できる
- 'all'オプションは複数のソート基準（cpu, reads, writes, duration, executions, memory grant, spills）でデータを処理するため負荷が高い

---

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

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

### 推奨読解順序

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

パラメータ定義と条件判定に関わる変数を理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | sp_BlitzAnalysis.sql | `sp_BlitzAnalysis.sql` | @BlitzCacheSortorder、@StartDate、@EndDate、@BringThePainパラメータの定義（行12-13, 24, 32） |

**読解のコツ**: @BringThePainはBIT型でデフォルト値0であり、明示的に1を指定しない限り警告が発生する設計になっている。

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

日付パラメータのデフォルト設定処理を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | sp_BlitzAnalysis.sql | `sp_BlitzAnalysis.sql` | @StartDate/@EndDateのデフォルト設定（行157-184） |

**主要処理フロー**:
1. **行157-169**: @StartDateがNULLの場合、1時間前を設定
2. **行171-184**: @EndDateがNULLの場合、@StartDate + 1時間またはSYSDATETIMEOFFSET()を設定

#### Step 3: 警告発生ロジック

大量データ警告の条件判定と通知出力処理を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | sp_BlitzAnalysis.sql | `sp_BlitzAnalysis.sql` | 大量データ警告の条件判定（行192-197） |

**主要処理フロー**:
- **行193**: IF条件 - @BlitzCacheSortorder = 'all' AND DATEDIFF(HOUR,@StartDate,@EndDate) > 4 AND @BringThePain = 0
- **行195**: RAISERROR文 - 警告メッセージの出力
- **行196**: RETURN文 - 処理中断

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

```
sp_BlitzAnalysis
    │
    ├─ パラメータ初期化
    │      ├─ @BlitzCacheSortorder NULL処理（行118-121）
    │      └─ @StartDate/@EndDate NULL処理（行157-184）
    │
    ├─ 大量データ警告チェック（行192-197）
    │      ├─ 条件判定: @BlitzCacheSortorder = 'all'
    │      ├─ 条件判定: DATEDIFF(HOUR) > 4
    │      ├─ 条件判定: @BringThePain = 0
    │      └─ RAISERROR + RETURN（行195-196）
    │
    └─ 通常処理へ継続
```

### データフロー図

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

@BlitzCacheSortorder ─────────┐
                              │
@StartDate ───────────────────┼──▶ 条件判定 ───▶ ┌─────────────────┐
                              │      │           │ 3条件すべて満たす │
@EndDate ─────────────────────┤      │           │ → RAISERROR     │
                              │      │           │ + RETURN        │
@BringThePain ────────────────┘      │           └─────────────────┘
                                     │                   │
                                     ▼                   ▼
                              ┌─────────────┐    クライアントへ
                              │ 条件不成立   │    警告メッセージ
                              │ → 処理継続  │
                              └─────────────┘
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| sp_BlitzAnalysis.sql | `sp_BlitzAnalysis.sql` | ソース | メインストアドプロシージャ、通知発生元 |
| Install-All-Scripts.sql | `Install-All-Scripts.sql` | ソース | 全スクリプトインストーラー（同一ロジック含む可能性） |
| Install-Azure.sql | `Install-Azure.sql` | ソース | Azure用インストーラー（同一ロジック含む可能性） |
