# 通知設計書 94-バックアップ挿入

## 概要

本ドキュメントは、sp_BlitzBackupsストアドプロシージャにおける「バックアップ挿入」通知メッセージの設計を定義する。この通知は、バックアップ履歴データの収集・挿入処理の進行状況を示す情報メッセージである。

### 本通知の処理概要

**業務上の目的・背景**：sp_BlitzBackupsはSQL Serverのバックアップ戦略を分析し、RPO（Recovery Point Objective）とRTO（Recovery Time Objective）を評価するストアドプロシージャである。この分析のために、msdb.dbo.backupsetからバックアップ履歴を収集し、一時テーブルに格納する必要がある。この通知は、バックアップデータの収集・挿入処理の開始を管理者に通知し、処理の進行状況を可視化する。

**通知の送信タイミング**：sp_BlitzBackups実行時、MSDBからのバックアップ履歴データ収集処理の開始時に送信される。

**通知の受信者**：SQLクライアント（SSMS、sqlcmd、アプリケーション）を通じてストアドプロシージャを実行している管理者またはオペレータ。RAISERROR WITH NOWAITにより即座にメッセージが出力される。

**通知内容の概要**：バックアップ挿入処理の開始を示すメッセージ。「Inserting to #Backups」という形式で出力される。

**期待されるアクション**：基本的に確認のみ。バックアップ履歴が大量の場合は処理に時間がかかる可能性があるため、@HoursBackパラメータで対象期間を絞り込むことを検討する。

## 通知種別

RAISERROR情報メッセージ（SQLクライアント出力）

## 送信仕様

### 基本情報

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

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

RAISERROR WITH NOWAITによりSQL Serverクライアントへ即座にメッセージを送信。接続中のすべてのクライアントセッションで受信可能。

## 通知テンプレート

### メッセージ出力の場合

| 項目 | 内容 |
|-----|------|
| 出力形式 | RAISERRORメッセージ |
| 重大度 | 0（情報） |
| 状態 | 1 |

### 本文テンプレート

```
Inserting to #Backups
```

### 添付ファイル

該当なし

## テンプレート変数

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

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| ストアドプロシージャ実行 | バックアップ挿入処理開始 | @PushBackupHistoryToListener = 0の場合 | 通常のバックアップ分析フローで送信 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| @PushBackupHistoryToListener = 1 | リスナーへのプッシュモード時はスキップ |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[sp_BlitzBackups実行開始] --> B{PushBackupHistoryToListener?}
    B -->|Yes| C[PushBackupHistoryToListener処理へ]
    B -->|No| D[RAISERROR: Inserting to #Backups]
    D --> E[動的SQL構築]
    E --> F[WITH Backups AS CTE作成]
    F --> G[msdb.dbo.backupsetからデータ取得]
    G --> H[Full/Diff/Logバックアップ情報結合]
    H --> I[#Backupsテーブルに挿入]
    I --> J[RPO分析へ]
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| msdb.dbo.backupset | バックアップ履歴 | @MSDBNameパラメータで指定可能 |

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

#### msdb.dbo.backupset

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| database_name | データベース名 | GROUP BY対象 |
| database_guid | データベースGUID | GROUP BY対象 |
| type | バックアップ種別 | D=Full, I=Diff, L=Log |
| backup_size | バックアップサイズ | 統計計算用 |
| compressed_backup_size | 圧縮後サイズ | 統計計算用 |
| backup_start_date | 開始日時 | スループット計算用 |
| backup_finish_date | 終了日時 | スループット計算用 |
| is_damaged | 破損フラグ | is_damaged = 0でフィルタ |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| #Backups | INSERT | バックアップ統計情報を格納 |

#### #Backupsテーブル

| 操作 | 項目（カラム名） | 更新値 | 備考 |
|-----|-----------------|-------|------|
| INSERT | database_name | データベース名 | 主キー |
| INSERT | database_guid | データベースGUID | 主キー |
| INSERT | FullMBpsAvg/Min/Max | フルバックアップスループット | MB/秒 |
| INSERT | FullSizeMBAvg/Min/Max | フルバックアップサイズ | MB |
| INSERT | DiffMBpsAvg/Min/Max | 差分バックアップスループット | MB/秒 |
| INSERT | LogMBpsAvg/Min/Max | ログバックアップスループット | MB/秒 |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| MSDBアクセスエラー | @MSDBNameが存在しない | @MSDBNameパラメータを確認 |
| 権限エラー | msdb.dbo.backupsetへのアクセス権限不足 | SELECT権限を付与 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

- msdb.dbo.backupsetへのSELECT権限が必要
- バックアップパス情報が含まれる可能性があるため、出力先のアクセス制御に注意
- RAISERRORメッセージ自体には機密情報は含まれない

## 備考

- @HoursBackパラメータで分析対象期間を制御可能（デフォルト168時間=7日）
- バックアップ種別ごと（Full/Diff/Log）にスループットとサイズの統計を計算
- 複数のMSDBを指定可能（@MSDBNameパラメータ）

---

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

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

### 推奨読解順序

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

バックアップ挿入処理で使用される一時テーブルの構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | sp_BlitzBackups.sql | `sp_BlitzBackups.sql` | #Backupsテーブルの定義（行124-165）を確認 |

**読解のコツ**: #Backupsテーブルの各カラムは、Full/Diff/Logごとにスループットとサイズの統計値を持つ。

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

バックアップ挿入処理の開始点を把握する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | sp_BlitzBackups.sql | `sp_BlitzBackups.sql` | RAISERROR 'Inserting to #Backups'の位置（行255）を確認 |

**主要処理フロー**:
1. **行251-252**: @PushBackupHistoryToListenerの判定
2. **行255**: 「Inserting to #Backups」RAISERRORメッセージ
3. **行257-315**: 動的SQLによるバックアップデータ取得・挿入

#### Step 3: 動的SQLを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | sp_BlitzBackups.sql | `sp_BlitzBackups.sql` | WITH Backups AS CTEの構造を確認 |

**主要処理フロー**:
- **行259-268**: CTE内でのAVG/MIN/MAX統計計算
- **行271-273**: backupsetからのフィルタ条件
- **行275-310**: Full/Diff/Logの結合とINSERT INTO #Backups

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

```
sp_BlitzBackups
    |
    +-- [パラメータ検証]
    |      |
    |      +-- @MSDBName存在確認
    |
    +-- [処理分岐]
    |      |
    |      +-- @PushBackupHistoryToListener = 1 → リスナープッシュ処理へGOTO
    |      +-- @PushBackupHistoryToListener = 0 → 通常分析処理へ
    |
    +-- [バックアップ挿入処理]
           |
           +-- RAISERROR 'Inserting to #Backups'  <-- 本通知
           +-- 動的SQL構築
           |      +-- WITH Backups AS (SELECT ... FROM msdb.dbo.backupset)
           |      +-- AVG/MIN/MAX統計計算
           +-- sp_executesql実行
           +-- #Backupsに結果格納
```

### データフロー図

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

@MSDBName ─────────────┐
                       │
msdb.dbo.backupset ────┼──▶ WITH Backups AS CTE ──▶ 統計計算 ──▶ #Backups
                       │         |
@HoursBack ────────────┘         |
@StartTime ──────────────────────┘
                                    |
                                    ▼
                              RAISERROR出力 ─────────────────────▶ SQLクライアント
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| sp_BlitzBackups.sql | `sp_BlitzBackups.sql` | ソース | バックアップ分析の本体プロシージャ。バックアップ挿入処理を含む |
