# 通知設計書 24-msdb書き込み禁止

## 概要

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

### 本通知の処理概要

**業務上の目的・背景**：sp_BlitzBackupsのバックアップ履歴プッシュ機能は、複数サーバーのバックアップ履歴を集約するために設計されている。msdbはSQL Serverのシステムデータベースであり、外部からの直接書き込みは避けるべきである。代わりに、msdbと同じスキーマを持つ「偽のmsdb」（ユーザー定義データベース）を使用することで、システムの整合性を保護しつつ履歴の集約を可能にする。

**通知の送信タイミング**：@PushBackupHistoryToListener = 1で実行され、@WriteBackupsToDatabaseNameのNULLチェックを通過した後、値が'msdb'かどうかを確認した時点で発生する。

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

**通知内容の概要**：実際のmsdbには書き込めず、偽のmsdbを使用する必要がある旨を通知する。

**期待されるアクション**：ユーザーはmsdb以外のデータベース名（例：DBA_msdb、BackupHistory等）を@WriteBackupsToDatabaseNameパラメータに指定する。そのデータベースにはmsdb.dbo.backupsetと互換性のあるテーブル構造が必要。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

### エラーメッセージ

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

### 本文テンプレート

```
We can't write to the real msdb, we have to write to a fake msdb.
```

### 添付ファイル

なし

## テンプレート変数

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

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| プロシージャ実行 | sp_BlitzBackups実行（プッシュモード） | @PushBackupHistoryToListener = 1 AND LOWER(@WriteBackupsToDatabaseName) = N'msdb' | msdb指定時 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| @PushBackupHistoryToListener = 0 | プッシュ機能未使用時 |
| @WriteBackupsToDatabaseNameがmsdb以外 | 適切なデータベース名が指定された場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[PushBackupHistoryToListenerラベル] --> B{@WriteBackupsToDatabaseName IS NULL?}
    B -->|Yes| C[エラー: 出力先無効]
    B -->|No| D{LOWER(@WriteBackupsToDatabaseName) = 'msdb'?}
    D -->|No| E[次の検証へ]
    D -->|Yes| F[RAISERROR発行]
    F --> G[RETURN - 処理終了]
```

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

### 参照テーブル一覧

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

### 更新テーブル一覧

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

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 禁止データベース指定 | msdbが指定された | msdb以外のデータベースを指定 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

- システムデータベース（msdb）への外部書き込みを防止するセキュリティ機能
- エラーメッセージには機密情報を含まない

## 備考

- LOWER()関数を使用して大文字小文字を区別しない比較を行う
- このチェックはNULLチェックの直後に実行される
- 偽のmsdbにはmsdb.dbo.backupsetと互換性のあるスキーマが必要

---

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

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

### 推奨読解順序

#### Step 1: 検証ロジックの流れを確認

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | sp_BlitzBackups.sql | `sp_BlitzBackups.sql` | PushBackupHistoryToListenerラベル以降の検証フロー |

**主要処理フロー**:
1. **行1157-1161**: @WriteBackupsToDatabaseName IS NULL チェック
2. **行1163-1167**: LOWER(@WriteBackupsToDatabaseName) = N'msdb' チェック
3. **行1165**: RAISERROR発行

#### Step 2: 検証条件の詳細を理解

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | sp_BlitzBackups.sql | `sp_BlitzBackups.sql` | LOWER関数による大文字小文字無視の比較 |

**主要処理フロー**:
- **行1163**: `IF LOWER(@WriteBackupsToDatabaseName) = N'msdb'`
- **行1164-1166**: BEGIN...RAISERROR...RETURN...END ブロック

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

```
sp_BlitzBackups (PushBackupHistoryToListenerモード)
    |
    +-- @WriteBackupsToDatabaseName IS NULL チェック
    |       |
    |       +-- NULL → エラー（No.23）
    |       +-- NOT NULL → 次へ
    |
    +-- LOWER(@WriteBackupsToDatabaseName) = 'msdb' チェック
    |       |
    |       +-- 'msdb' → RAISERROR + RETURN（本エラー）
    |       +-- それ以外 → 次の検証へ
    |
    +-- @WriteBackupsToListenerName / @AGName チェック
    |
    +-- 履歴プッシュ処理
```

### データフロー図

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

@WriteBackupsToDatabaseName ───> LOWER() + 'msdb'比較 ───> RAISERROR (msdb時)
                                         |
                                         +────────────────> 次の検証 (その他)
```

### 関連ファイル一覧

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