# 通知設計書 40-BlitzAnalysisデータベース無効

## 概要

本ドキュメントは、sp_BlitzAnalysisストアドプロシージャにおいて、@OutputDatabaseNameパラメータに無効なデータベース名が指定された場合に発生するエラー通知の設計を記述する。

### 本通知の処理概要

この通知は、診断分析処理において、BlitzFirst、BlitzCache、BlitzWhoなどの診断データが格納されているデータベースの名前が無効（存在しない）場合にユーザーに警告を発するためのエラーメッセージである。

**業務上の目的・背景**：sp_BlitzAnalysisは、First Responder Kitの各診断ストアドプロシージャ（sp_BlitzFirst、sp_BlitzCache等）が記録したデータを分析・集計するためのユーティリティである。これらの診断データは通常、専用のDBAデータベース（デフォルト: DBAtools）に格納される。分析を実行する際に、データが格納されているデータベースを正しく指定する必要があり、存在しないデータベースを指定した場合は分析が不可能となる。この事前検証により、ユーザーに早期に問題を通知し、正しいデータベース名の指定を促す。

**通知の送信タイミング**：sp_BlitzAnalysisストアドプロシージャの実行開始直後、パラメータ検証フェーズで発生する。DB_ID(@OutputDatabaseName)がNULLを返す（データベースが存在しない）場合にトリガーされる。

**通知の受信者**：ストアドプロシージャを実行したSQL Serverセッションの呼び出し元ユーザーまたはアプリケーション。RAISERRORによりクライアントに直接メッセージが返され、処理は即座に終了する。

**通知内容の概要**：エラーメッセージとして「Invalid database name provided for parameter @OutputDatabaseName: %s」が表示され、指定された無効なデータベース名を明示的に伝える。

**期待されるアクション**：ユーザーは@OutputDatabaseNameパラメータの値を確認し、実際に存在するデータベース名（診断データが格納されているデータベース）を指定する必要がある。デフォルト値は'DBAtools'であるが、環境によって異なる可能性がある。

## 通知種別

SQLエラーメッセージ（RAISERROR - Severity 11, State 0）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期 |
| 優先度 | 中（Severity 11） |
| リトライ | 無（処理即時終了） |

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

現在のSQL Serverセッションの呼び出し元に対してRAISERRORでメッセージを送信。Severity 11のため、ユーザー定義エラーとして扱われ、処理は即座に終了する。

## 通知テンプレート

### SQLエラーメッセージ

| 項目 | 内容 |
|-----|------|
| メッセージレベル | 11（ユーザー定義エラー） |
| 状態 | 0 |
| オプション | なし |

### 本文テンプレート

```
Invalid database name provided for parameter @OutputDatabaseName: %s
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| %s | 指定されたデータベース名 | @OutputDatabaseName | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| ストアドプロシージャ実行 | sp_BlitzAnalysisの呼び出し | DB_ID(@OutputDatabaseName) IS NULL | 指定されたデータベースが存在しない場合にエラーを発生 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| DB_ID(@OutputDatabaseName) IS NOT NULL | データベースが存在する場合は通知しない |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[sp_BlitzAnalysis実行開始] --> B[パラメータ検証開始]
    B --> C{DB_ID(@OutputDatabaseName) IS NULL?}
    C -->|Yes| D[RAISERROR発生]
    C -->|No| E[テーブル名構築処理へ]
    D --> F[RETURN - 処理終了]
    E --> G[各種分析処理実行]
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| なし | DB_ID()関数でデータベース存在を確認 | システム関数を使用 |

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

- DB_ID()関数はsys.databasesカタログビューを内部的に参照

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| なし | - | ログ出力のみでテーブル更新なし |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| データベース不存在 | 指定したデータベースが存在しない | 正しいデータベース名を指定 |
| 入力ミス | データベース名のタイプミス | データベース名を修正 |
| 環境差異 | 別環境ではデータベース名が異なる | 対象環境の正しいデータベース名を確認 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 0（リトライなし、即座に処理終了） |
| リトライ間隔 | - |
| リトライ対象エラー | - |

## 配信設定

### レート制限

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

### 配信時間帯

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

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

- エラーメッセージにデータベース名が含まれるが、これは入力値であり機密性は低い
- 存在しないデータベース名が露出するが、セキュリティリスクは限定的

## 備考

- @OutputDatabaseNameのデフォルト値は'DBAtools'
- @OutputSchemaName、各種@OutputTableName*パラメータも存在するが、このエラーはデータベースレベルの存在チェック
- 後続の処理で各テーブルの存在チェックも行われる（テーブルが存在しない場合は別のメッセージが出力される）
- DB_ID()関数はデータベースが存在しない場合にNULLを返す

---

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

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

### 推奨読解順序

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

@OutputDatabaseNameパラメータと関連パラメータの定義を理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | sp_BlitzAnalysis.sql | `sp_BlitzAnalysis.sql` | パラメータ定義（行14-34）を確認 |

**読解のコツ**: @OutputDatabaseNameはNVARCHAR(256)型で、デフォルト値'DBAtools'が設定されている。

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

処理の起点となるファイル・関数を特定。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | sp_BlitzAnalysis.sql | `sp_BlitzAnalysis.sql` | ストアドプロシージャの開始点（行10-35）でパラメータ定義を確認 |

**主要処理フロー**:
1. **行14**: @OutputDatabaseName NVARCHAR(256) = 'DBAtools' としてパラメータ宣言
2. **行88-93**: データベース存在チェック

#### Step 3: 検証ロジックを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | sp_BlitzAnalysis.sql | `sp_BlitzAnalysis.sql` | 行88-93でデータベース存在チェックを確認 |

**主要処理フロー**:
- **行89**: DB_ID(@OutputDatabaseName) IS NULL - 存在チェック
- **行91**: RAISERROR発生
- **行92**: RETURN - 処理終了

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

```
sp_BlitzAnalysis
    |
    +-- バージョンチェック (行42-45)
    |
    +-- ヘルプ表示 (行47-74)
    |
    +-- 変数宣言 (行77-86)
    |
    +-- データベース検証 (行88-93) ← 本通知の発生箇所
    |       |
    |       +-- DB_ID() チェック (行89)
    |       |
    |       +-- RAISERROR (行91)
    |       |
    |       +-- RETURN (行92)
    |
    +-- テーブル名構築 (行95-101)
    |
    +-- 各種分析処理
            |
            +-- BlitzFirst分析 (行207-292)
            |
            +-- WaitStats分析 (行294-365)
            |
            +-- FileStats分析 (行367-442)
            |
            +-- Perfmon分析 (行444-490)
            |
            +-- BlitzCache分析 (行492-743)
            |
            +-- BlitzWho分析 (行745-888)
```

### データフロー図

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

@OutputDatabaseName ───▶ DB_ID() 関数 ───▶ NULL チェック ───▶ RAISERROR
  ('DBAtools')              (行89)           (行89)           (メッセージ)
       |                                         |
       v                                         v
  ユーザー指定                              データベースが
  または                                    存在しない場合
  デフォルト値
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| sp_BlitzAnalysis.sql | `sp_BlitzAnalysis.sql` | ソース | 診断データ分析用ストアドプロシージャ本体 |
| sp_BlitzFirst.sql | `sp_BlitzFirst.sql` | 関連ソース | 診断データの生成元（BlitzFirst） |
| sp_BlitzCache.sql | `sp_BlitzCache.sql` | 関連ソース | 診断データの生成元（BlitzCache） |
| sp_BlitzWho.sql | `sp_BlitzWho.sql` | 関連ソース | 診断データの生成元（BlitzWho） |
