# 通知設計書 23-出力先無効

## 概要

sp_BlitzBackupsプロシージャにおいて、@PushBackupHistoryToListener = 1（バックアップ履歴をリスナーにプッシュ）モードで実行時に、@WriteBackupsToDatabaseNameパラメータがNULLの場合に発生するエラーメッセージの設計書。

### 本通知の処理概要

**業務上の目的・背景**：sp_BlitzBackupsのバックアップ履歴プッシュ機能では、リモートサーバーのデータベースにバックアップ履歴を書き込む。この機能を使用する際には、書き込み先のデータベース名が必須であり、NULLが指定された場合はエラーを発生させて処理を中断する。これにより、不完全な設定での実行を防止する。

**通知の送信タイミング**：@PushBackupHistoryToListener = 1で実行され、PushBackupHistoryToListenerラベルにジャンプした後、@WriteBackupsToDatabaseNameがNULLかどうかを確認した時点で発生する。

**通知の受信者**：sp_BlitzBackupsを実行したデータベース管理者。

**通知内容の概要**：@WriteBackupsToDatabaseNameパラメータがNULLに設定されているが、この値は必須である旨を通知する。

**期待されるアクション**：ユーザーは@WriteBackupsToDatabaseNameパラメータに、バックアップ履歴を書き込む先のデータベース名を指定する。ただしmsdbは使用できない（別のエラーが発生する）。

## 通知種別

SQL Serverエラーメッセージ（RAISERROR）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（即時） |
| 優先度 | 高（重大度16） |
| リトライ | 無し |

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

プロシージャを実行したセッションに対して直接エラーメッセージとして送信される。

## 通知テンプレート

### エラーメッセージ

| 項目 | 内容 |
|-----|------|
| メッセージ形式 | RAISERROR |
| 重大度 | 16 |
| 状態 | 1 |

### 本文テンプレート

```
@WriteBackupsToDatabaseName can't be NULL.
```

### 添付ファイル

なし

## テンプレート変数

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

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| プロシージャ実行 | sp_BlitzBackups実行（プッシュモード） | @PushBackupHistoryToListener = 1 AND @WriteBackupsToDatabaseName IS NULL | 出力DB名未指定 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| @PushBackupHistoryToListener = 0 | プッシュ機能未使用時 |
| @WriteBackupsToDatabaseNameに値あり | 正常なデータベース名が指定された場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[sp_BlitzBackups実行] --> B{@PushBackupHistoryToListener = 1?}
    B -->|No| C[通常のバックアップ分析処理]
    B -->|Yes| D[PushBackupHistoryToListenerラベル]
    D --> E{@WriteBackupsToDatabaseName IS NULL?}
    E -->|No| F[次の検証へ]
    E -->|Yes| G[RAISERROR発行]
    G --> H[RETURN - 処理終了]
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| なし | パラメータ検証のみ | データベースアクセスなし |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| なし | - | エラー発生時は処理中断 |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 必須パラメータ未設定 | @WriteBackupsToDatabaseNameがNULL | 有効なデータベース名を指定 |

### リトライ仕様

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

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 制限なし | プロシージャ実行毎に即時発行 |

### 配信時間帯

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

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

- エラーメッセージには機密情報を含まない
- パラメータ値自体はメッセージに出力されない

## 備考

- このチェックは@PushBackupHistoryToListener = 1の場合のみ実行される
- @WriteBackupsToDatabaseNameのデフォルト値はNULL
- 'msdb'を指定した場合は別のエラー（No.24 msdb書き込み禁止）が発生する

---

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

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

### 推奨読解順序

#### Step 1: パラメータ定義とモード分岐を確認

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | sp_BlitzBackups.sql | `sp_BlitzBackups.sql` | @PushBackupHistoryToListenerと@WriteBackupsToDatabaseNameの定義 |

**主要処理フロー**:
1. **行13**: `@PushBackupHistoryToListener BIT = 0` - フラグ定義
2. **行15**: `@WriteBackupsToDatabaseName NVARCHAR(256) = NULL` - パラメータ定義
3. **行251-252**: GOTO PushBackupHistoryToListener - モード分岐

#### Step 2: 検証ロジックを理解

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | sp_BlitzBackups.sql | `sp_BlitzBackups.sql` | NULLチェックとRAISERROR発行 |

**主要処理フロー**:
- **行1149**: `PushBackupHistoryToListener:` ラベル
- **行1157-1161**: @WriteBackupsToDatabaseName IS NULL チェック
- **行1159**: RAISERROR発行

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

```
sp_BlitzBackups
    |
    +-- @PushBackupHistoryToListener = 1 の場合
    |       |
    |       +-- GOTO PushBackupHistoryToListener
    |
    +-- PushBackupHistoryToListener:
            |
            +-- @WriteBackupsToDatabaseName IS NULL チェック
            |       |
            |       +-- NULL → RAISERROR + RETURN
            |       |
            |       +-- NOT NULL → 次の検証へ
            |
            +-- @WriteBackupsToDatabaseName = 'msdb' チェック
            |
            +-- リンクサーバー検証
            |
            +-- 履歴プッシュ処理
```

### データフロー図

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

@PushBackupHistoryToListener ───> モード判定
                                     |
                                     +──> @WriteBackupsToDatabaseName検証
                                              |
                                              +──> RAISERROR (NULL時)
                                              |
                                              +──> 履歴プッシュ (正常時)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| sp_BlitzBackups.sql | `sp_BlitzBackups.sql` | ソース | バックアップ分析プロシージャ |
