# 通知設計書 97-バックアップ履歴プッシュ

## 概要

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

### 本通知の処理概要

**業務上の目的・背景**：複数のSQL Serverインスタンスからバックアップ履歴を中央集約する場合、各サーバーのmsdb.dbo.backupsetのデータをリモートのリスナーにプッシュする必要がある。sp_BlitzBackupsの@PushBackupHistoryToListenerパラメータを有効にすることで、この機能を利用できる。この通知は、リモートリスナーへのバックアップ履歴プッシュ処理の開始を管理者に通知する。

**通知の送信タイミング**：@PushBackupHistoryToListener = 1が指定された場合、リスナーへのバックアップ履歴データ転送処理開始時に送信される。

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

**通知内容の概要**：バックアップ履歴プッシュ処理の開始を示すメッセージ。「Pushing backup history to listener」という形式で出力される。

**期待されるアクション**：基本的に確認のみ。プッシュ処理が失敗した場合は、リンクサーバーの設定、対象データベースの存在、backupsetテーブルの存在などを確認する。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

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

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

### 本文テンプレート

```
Pushing backup history to listener
```

### 添付ファイル

該当なし

## テンプレート変数

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

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| ストアドプロシージャ実行 | プッシュ処理開始 | @PushBackupHistoryToListener = 1 | リスナーへのデータ転送開始を通知 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| @PushBackupHistoryToListener = 0 | 通常分析モードではスキップ |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[sp_BlitzBackups実行開始] --> B{@PushBackupHistoryToListener = 1?}
    B -->|No| C[通常分析処理へ]
    B -->|Yes| D[PushBackupHistoryToListenerラベルへGOTO]
    D --> E[RAISERROR: Pushing backup history to listener]
    E --> F{@WriteBackupsToDatabaseName = NULL?}
    F -->|Yes| G[エラー: パラメータNULL]
    F -->|No| H{リンクサーバー存在確認}
    H -->|No| I[エラー: リンクサーバー未設定]
    H -->|Yes| J{対象データベース存在確認}
    J -->|No| K[エラー: データベース未存在]
    J -->|Yes| L{backupsetテーブル存在確認}
    L -->|No| M[テーブル作成]
    L -->|Yes| N[バックアップ履歴挿入]
    M --> N
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| msdb.dbo.backupset | バックアップ履歴（ソース） | ローカルのバックアップ履歴 |
| sys.servers | リンクサーバー確認 | @WriteBackupsToListenerNameの存在確認 |
| sys.availability_groups | AG情報 | @AGNameからリスナー名を取得 |
| sys.availability_group_listeners | AGリスナー情報 | dns_name取得用 |

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

#### sys.servers

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| name | サーバー名 | @WriteBackupsToListenerNameとの比較 |

#### msdb.dbo.backupset

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| backup_set_uuid | 一意識別子 | 重複排除用 |
| database_name | データベース名 | 転送対象 |
| backup_start_date | 開始日時 | @WriteBackupsLastHoursでフィルタ |
| 全カラム | バックアップ情報 | 転送対象 |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| リモート.dbo.backupset | CREATE/INSERT | リモートにバックアップ履歴を格納 |

#### リモートbackupsetテーブル

| 操作 | 項目（カラム名） | 更新値 | 備考 |
|-----|-----------------|-------|------|
| CREATE | 全カラム | msdb.dbo.backupset互換 | テーブル未存在時に作成 |
| INSERT | 全カラム | ローカルbackupsetの値 | 重複排除して挿入 |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| パラメータNULLエラー | @WriteBackupsToDatabaseName = NULL | パラメータを指定 |
| msdb書き込み禁止 | @WriteBackupsToDatabaseName = 'msdb' | 別のデータベース名を指定 |
| リンクサーバー未設定 | リスナーへのリンクサーバーがない | リンクサーバーを作成 |
| データベース未存在 | 対象DBがリモートに存在しない | データベースを作成 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

- リモートリンクサーバーへの接続権限が必要
- リモートデータベースへのCREATE TABLE/INSERT権限が必要
- バックアップパス情報がリモートに転送されるため、アクセス制御に注意
- RAISERRORメッセージ自体には機密情報は含まれない

## 備考

- @AGNameパラメータでAvailability Group名を指定可能
- @WriteBackupsLastHoursで転送対象期間を制限可能（デフォルト168時間）
- backupsetテーブルが存在しない場合は自動作成
- 主キーとインデックスも自動作成される

---

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

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

### 推奨読解順序

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

プッシュ処理で使用されるパラメータとテーブル構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | sp_BlitzBackups.sql | `sp_BlitzBackups.sql` | パラメータ定義（@PushBackupHistoryToListener等）を確認 |

**読解のコツ**: 行13-16で関連パラメータが定義されている。

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

プッシュ処理の開始点を把握する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | sp_BlitzBackups.sql | `sp_BlitzBackups.sql` | PushBackupHistoryToListenerラベル（行1149）を確認 |

**主要処理フロー**:
1. **行251-252**: @PushBackupHistoryToListener判定とGOTO
2. **行1149**: PushBackupHistoryToListenerラベル
3. **行1151**: 「Pushing backup history to listener」RAISERRORメッセージ
4. **行1157-1200**: パラメータ検証とリンクサーバー確認

#### Step 3: テーブル作成・データ挿入を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | sp_BlitzBackups.sql | `sp_BlitzBackups.sql` | CREATE TABLE/INSERT処理を確認 |

**主要処理フロー**:
- **行1233-1262**: backupsetテーブル未存在時のCREATE TABLE
- **行1267-1319**: インデックス作成処理
- **行1340以降**: INSERT処理（NOT EXISTS条件で重複排除）

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

```
sp_BlitzBackups
    |
    +-- [パラメータ判定]
    |      +-- @PushBackupHistoryToListener = 1 → GOTOラベルへ
    |
    +-- [PushBackupHistoryToListener処理]
           |
           +-- RAISERROR 'Pushing backup history to listener'  <-- 本通知
           +-- @WriteBackupsToDatabaseName検証
           +-- リンクサーバー存在確認
           |      +-- sys.servers参照
           +-- リモートデータベース存在確認
           +-- backupsetテーブル存在確認
           |      +-- 未存在時: CREATE TABLE
           |      +-- インデックス作成（PK、backup_set_uuid、media_set_id）
           +-- バックアップ履歴INSERT
                  +-- msdb.dbo.backupset SELECT
                  +-- NOT EXISTS条件で重複排除
                  +-- EXEC AT リンクサーバー
```

### データフロー図

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

@WriteBackupsToListenerName ────┐
@WriteBackupsToDatabaseName ────┼──▶ パラメータ検証 ──────────▶ エラーまたは続行
@AGName ────────────────────────┘
                                    |
msdb.dbo.backupset ─────────────▶ SELECT ──────────▶ リモート.dbo.backupset
                                    |
                                    ▼
                              RAISERROR出力 ────────────────▶ SQLクライアント
```

### 関連ファイル一覧

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