# 通知設計書 100-ファイル移動調整

## 概要

本ドキュメントは、sp_DatabaseRestoreストアドプロシージャにおける「ファイル移動調整」通知メッセージの設計を定義する。この通知は、@MoveFiles = 1が指定された場合にデータファイルおよびログファイルの移動先パスを調整する処理の進行状況を示す情報メッセージである。

### 本通知の処理概要

**業務上の目的・背景**：sp_DatabaseRestoreはバックアップファイルからデータベースを復元する際、元のファイル配置とは異なる場所にファイルを移動して復元できる。@MoveFiles = 1を指定すると、データファイルは@MoveDataDriveへ、ログファイルは@MoveLogDriveへ移動される。この通知は、RESTORE文にMOVEオプションを追加するパス調整処理の開始を管理者に通知する。

**通知の送信タイミング**：sp_DatabaseRestore実行時、@MoveFiles = 1が指定されている場合に、RESTORE文のMOVEオプション生成処理開始時に送信される。

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

**通知内容の概要**：ファイル移動パス調整処理の開始を示すメッセージ。「@MoveFiles = 1, adjusting paths」という形式で出力される。

**期待されるアクション**：基本的に確認のみ。ファイル移動が意図した場所になっているかを確認し、問題があれば@MoveDataDrive、@MoveLogDrive等のパラメータを調整する。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

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

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

### 本文テンプレート

```
@MoveFiles = 1, adjusting paths
```

### 添付ファイル

該当なし

## テンプレート変数

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

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| ストアドプロシージャ実行 | ファイル移動パス調整開始 | @MoveFiles = 1 | MOVEオプション生成の開始を通知 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| @MoveFiles = 0 | ファイル移動なしのため通知なし |
| @Execute = 'N' | 実行モードでない場合はスキップ |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[sp_DatabaseRestore実行開始] --> B[パラメータ検証]
    B --> C[バックアップファイル情報取得]
    C --> D{@MoveFiles = 1?}
    D -->|No| E[元のパスで復元]
    D -->|Yes| F[RAISERROR: @MoveFiles = 1, adjusting paths]
    F --> G[#FileListParametersから論理名取得]
    G --> H[ファイルタイプ判定D/L/S/F]
    H --> I[新しいパス生成]
    I --> J[MOVEオプション文字列構築]
    J --> K[RESTORE DATABASE文生成]
    K --> L[復元実行]
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| #FileListParameters | バックアップファイル内のファイル一覧 | RESTORE FILELISTONLYで取得 |

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

#### #FileListParameters

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| LogicalName | 論理ファイル名 | MOVEオプションで使用 |
| PhysicalName | 物理パス | 新パス生成の参照元 |
| Type | ファイルタイプ | D=Data, L=Log, S=Filestream, F=FullText |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| なし | @MoveOption変数への文字列結合のみ | - |

#### @MoveOption変数

| 操作 | 項目 | 生成値 | 備考 |
|-----|------|-------|------|
| 文字列結合 | MOVE句 | , MOVE 'LogicalName' TO 'NewPath' | ファイルごとに生成 |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| パス生成エラー | ドライブパスが無効 | @MoveDataDrive、@MoveLogDrive等を確認 |
| ファイル名重複 | 同名ファイルが存在 | @FileNamePrefixパラメータを使用 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

- 移動先パスへの書き込み権限が必要
- RAISERRORメッセージ自体には機密情報は含まれない

## 備考

- ファイルタイプごとに移動先が決定される（D→@MoveDataDrive、L→@MoveLogDrive等）
- @FileNamePrefixでファイル名の先頭に文字列を追加可能
- 復元先データベース名が元と異なる場合はファイル名も置換される
- @Debug = 1で生成されたMOVEオプションを確認可能

---

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

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

### 推奨読解順序

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

ファイル移動処理で使用されるパラメータとテーブルを理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | sp_DatabaseRestore.sql | `sp_DatabaseRestore.sql` | @MoveFilesパラメータ（行20）と#FileListParametersの定義を確認 |

**読解のコツ**: @MoveFiles BIT = 1がデフォルト値として設定されている。

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

ファイル移動処理の開始点を把握する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | sp_DatabaseRestore.sql | `sp_DatabaseRestore.sql` | @MoveFiles = 1の処理（行792-816）を確認 |

**主要処理フロー**:
1. **行792-794**: @MoveFiles = 1の判定とRAISERRORメッセージ
2. **行796-810**: WITH Files AS CTEでのターゲットパス生成
3. **行811-813**: @MoveOptionへのMOVE句追加
4. **行815**: @Debug = 1の場合にMOVEオプションを出力

#### Step 3: パス生成ロジックを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | sp_DatabaseRestore.sql | `sp_DatabaseRestore.sql` | CTE内のCASE式によるファイルタイプ判定を確認 |

**主要処理フロー**:
- **行799-803**: ファイルタイプに応じたドライブ選択
  - Type = 'D' → @MoveDataDrive
  - Type = 'L' → @MoveLogDrive
  - Type = 'S' → @MoveFilestreamDrive
  - Type = 'F' → @MoveFullTextCatalogDrive
- **行804-806**: ファイル名の取得とデータベース名置換
- **行811-812**: TargetPhysicalName <> PhysicalNameの条件でMOVE句生成

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

```
sp_DatabaseRestore
    |
    +-- [パラメータ検証]
    |
    +-- [バックアップファイル情報取得]
    |      +-- RESTORE FILELISTONLY実行
    |      +-- #FileListParametersに格納
    |
    +-- [ファイル移動パス調整]
           |
           +-- @MoveFiles = 1判定
           +-- RAISERROR '@MoveFiles = 1, adjusting paths'  <-- 本通知
           +-- WITH Files AS CTE
           |      +-- Type = 'D' → @MoveDataDrive
           |      +-- Type = 'L' → @MoveLogDrive
           |      +-- Type = 'S' → @MoveFilestreamDrive
           |      +-- Type = 'F' → @MoveFullTextCatalogDrive
           +-- @MoveOption += ', MOVE ''LogicalName'' TO ''NewPath'''
           +-- @Debug = 1 → PRINT @MoveOption
```

### データフロー図

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

#FileListParameters ─────┐
                         │
LogicalName ─────────────┼──▶ CTE Files ─────▶ TargetPhysicalName生成
PhysicalName ────────────┤                           |
Type ────────────────────┘                           ▼
                                          @MoveOption文字列構築
@MoveDataDrive ──────────┐                           |
@MoveLogDrive ───────────┼──▶ ドライブ選択          ▼
@MoveFilestreamDrive ────┤                   RESTORE DATABASE文
@MoveFullTextCatalogDrive┘                           |
                                                     ▼
                                          RAISERROR出力 ──▶ SQLクライアント
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| sp_DatabaseRestore.sql | `sp_DatabaseRestore.sql` | ソース | データベース復元の本体プロシージャ。ファイル移動調整処理を含む |
