# 通知設計書 33-フルバックアップ行なし

## 概要

本ドキュメントは、sp_DatabaseRestoreストアドプロシージャにおいて、指定されたバックアップパスでフルバックアップファイルが見つからない場合に発生するエラー通知の設計を記述する。

### 本通知の処理概要

この通知は、データベース復元操作において、xp_dirtreeによるフォルダ列挙を使用した際に、指定されたパスにバックアップファイルが存在しない場合にユーザーに警告を発するためのエラーメッセージである。

**業務上の目的・背景**：データベースの復元処理を実行する際、バックアップファイルが存在しなければ復元操作は不可能である。この通知により、ユーザーはバックアップファイルの配置ミスやパス指定の誤りを早期に検出し、問題を修正することができる。特にOla Hallengrenメンテナンスソリューションのファイル命名規則に従ったバックアップファイルを想定しているため、ファイル名の形式が異なる場合にも発生する可能性がある。

**通知の送信タイミング**：sp_DatabaseRestoreストアドプロシージャの実行中、バックアップファイル一覧の取得処理（SimpleFolderEnumeration = 1の場合）で発生する。xp_dirtreeの結果が空の場合にトリガーされる。

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

**通知内容の概要**：エラーメッセージとして「(FULL) No rows were returned for that database in path %s」が表示され、具体的なパスを明示してどのディレクトリでファイルが見つからなかったかを伝える。

**期待されるアクション**：ユーザーは指定したバックアップパス(@BackupPathFull)を確認し、正しいパスにバックアップファイルが存在するかを検証する必要がある。パスが正しい場合は、バックアップファイル名がsp_DatabaseRestoreの期待する命名規則（データベース名を含む.bakファイル）に従っているか確認する。

## 通知種別

SQLエラーメッセージ（RAISERROR - Severity 16, State 1）

## 送信仕様

### 基本情報

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

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

現在のSQL Serverセッションの呼び出し元に対してRAISERRORでメッセージを送信。WITH NOWAITオプションにより即時送信され、その後RETURNにより処理が終了する。

## 通知テンプレート

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

| 項目 | 内容 |
|-----|------|
| メッセージレベル | 16（ユーザーエラー） |
| 状態 | 1 |
| オプション | WITH NOWAIT |

### 本文テンプレート

```
(FULL) No rows were returned for that database in path %s
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| %s | バックアップパス | @CurrentBackupPathFull | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| ストアドプロシージャ実行 | sp_DatabaseRestoreの呼び出し | @SimpleFolderEnumeration = 1 AND NOT EXISTS (SELECT * FROM @FileList) | SimpleFolderEnumerationモードでファイルリストが空の場合にエラーを発生 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| @SimpleFolderEnumeration = 0 | xp_cmdshellモードでは別のエラーチェックが適用される |
| @FileListにレコードが存在する | バックアップファイルが見つかった場合は通知しない |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[sp_DatabaseRestore実行開始] --> B[バックアップパス設定]
    B --> C{@SimpleFolderEnumeration = 1?}
    C -->|Yes| D[xp_dirtreeでファイル一覧取得]
    C -->|No| E[xp_cmdshellでファイル一覧取得]
    D --> F{@FileListに行がある?}
    F -->|No| G[RAISERROR発生]
    F -->|Yes| H[処理続行]
    G --> I[RETURN - 処理終了]
    E --> J[別のエラーチェックへ]
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| sys.configurations | xp_cmdshellの有効/無効確認 | SimpleFolderEnumerationの自動設定に使用 |

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

#### sys.configurations

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| name | 設定名の確認 | WHERE name = 'xp_cmdshell' |
| value_in_use | xp_cmdshellの有効状態 | 値が1でない場合はSimpleFolderEnumeration = 1 |

### 更新テーブル一覧

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

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| ファイル不存在エラー | 指定パスにバックアップファイルが存在しない | パスを確認し、正しいバックアップファイルの場所を指定 |
| パス指定エラー | パスが存在しないまたはアクセス不可 | パスの存在とアクセス権限を確認 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

- エラーメッセージにファイルパスが含まれるため、パス情報が露出する
- 本番環境ではパス情報の露出がセキュリティリスクとなる可能性があることを考慮

## 備考

- このエラーはSimpleFolderEnumeration（xp_dirtree使用）モードでのみ発生
- xp_cmdshellモードでは「The system cannot find the path specified.」等の別メッセージでチェックされる
- メッセージの先頭に「(FULL)」が付与されており、フルバックアップ関連のエラーであることを示す

---

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

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

### 推奨読解順序

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

ファイルリストを格納するテーブル変数の構造を理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | sp_DatabaseRestore.sql | `sp_DatabaseRestore.sql` | @FileListSimpleテーブル変数の定義（行279-283）を確認 |
| 1-2 | sp_DatabaseRestore.sql | `sp_DatabaseRestore.sql` | @FileListテーブル変数の定義（行285-288）を確認 |

**読解のコツ**: テーブル変数は一時的なデータ格納用で、スコープはプロシージャ内に限定される。

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

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | sp_DatabaseRestore.sql | `sp_DatabaseRestore.sql` | SimpleFolderEnumerationの設定（行541-542）を確認 |

**主要処理フロー**:
1. **行541-542**: xp_cmdshellが無効な場合、SimpleFolderEnumeration = 1 に自動設定

#### Step 3: ファイル列挙ロジックを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | sp_DatabaseRestore.sql | `sp_DatabaseRestore.sql` | 行596-600でxp_dirtreeによるファイル列挙を確認 |
| 3-2 | sp_DatabaseRestore.sql | `sp_DatabaseRestore.sql` | 行619-627でファイル存在チェックとエラー発生を確認 |

**主要処理フロー**:
- **行596-600**: SimpleFolderEnumeration = 1の場合、xp_dirtreeでファイル一覧取得
- **行619-626**: @FileListが空の場合にRAISERROR発生
- **行624**: 具体的なエラーメッセージ出力

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

```
sp_DatabaseRestore
    |
    +-- パラメータ検証フェーズ
    |
    +-- バックアップファイル列挙フェーズ (行589-674)
    |       |
    |       +-- パスループ開始 (行589)
    |       |
    |       +-- SimpleFolderEnumeration判定 (行596)
    |       |       |
    |       |       +-- xp_dirtree実行 (行598)
    |       |       |
    |       |       +-- @FileListに挿入 (行599)
    |       |
    |       +-- ファイル存在チェック (行619-627) ← 本通知の発生箇所
    |               |
    |               +-- RAISERROR (行624)
    |               |
    |               +-- RETURN (行625)
    |
    +-- バックアップ復元処理（ファイル存在時）
```

### データフロー図

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

@BackupPathFull ───▶ パス分割処理 ───▶ ループ処理
                         (行571-587)      |
                                          v
                                    xp_dirtree実行 ───▶ @FileListSimple
                                       (行598)              |
                                                            v
                                                      @FileList挿入
                                                         (行599)
                                                            |
                                                            v
                                                     空チェック ───▶ RAISERROR
                                                      (行622)       (メッセージ)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| sp_DatabaseRestore.sql | `sp_DatabaseRestore.sql` | ソース | データベース復元用ストアドプロシージャ本体 |
