# 機能設計書 45-Restore-DbaDatabase

## 概要

本ドキュメントは、バックアップファイルからSQL Serverデータベースをリストアするdbatools PowerShellコマンド `Restore-DbaDatabase` の機能設計書である。

### 本機能の処理概要

この機能は、バックアップファイルをスキャンして最適なリストアシーケンスを自動選択し、特定のポイントインタイムまでデータベースを復旧する。フル、差分、トランザクションログバックアップから完全なバックアップチェーンを構築する複雑なタスクを自動化する。

**業務上の目的・背景**：災害復旧シナリオでは、データベースを迅速かつ正確にリストアする必要がある。手動でバックアップファイルを特定し、正しい順序でリストアコマンドを構築することは、時間がかかりミスも発生しやすい。本機能はこのプロセスを自動化し、バックアップヘッダーの検証、チェーンの完全性確認、ポイントインタイムリカバリを一括して実行する。

**機能の利用シーン**：
- 災害復旧時のデータベース復元
- テスト/開発環境への本番データベースコピー
- ポイントインタイムリカバリ（特定時点への復元）
- 可用性グループセットアップのためのデータベース準備
- ログシッピングセカンダリの初期化

**主要な処理内容**：
1. バックアップファイルの発見とヘッダー情報読取
2. バックアップチェーンの構築と検証
3. ファイルパスのリマッピング（必要に応じて）
4. リストアコマンドの生成と実行
5. ポイントインタイムリカバリの処理
6. ページリストア（オプション）

**関連システム・外部連携**：
- ローカルファイルシステム、ネットワーク共有、Azure Blob Storage、AWS S3
- Ola Hallengrenメンテナンスソリューションのフォルダ構造サポート

**権限による制御**：対象データベースへのリストア権限、ファイルシステムへのアクセス権限が必要。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 20 | データベースリストア | 主機能 | データベースのリストア実行 |

## 機能種別

データ復元 / 災害復旧

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter | Yes | リストア先SQL Serverインスタンス | - |
| SqlCredential | PSCredential | No | 代替認証情報 | - |
| Path | object[] | Yes* | バックアップファイルパス | *Recoverパラメータセット以外で必須 |
| DatabaseName | object[] | No | リストア先データベース名 | - |
| DestinationDataDirectory | string | No | データファイルのリストア先ディレクトリ | - |
| DestinationLogDirectory | string | No | ログファイルのリストア先ディレクトリ | - |
| DestinationFileStreamDirectory | string | No | FILESTREAMのリストア先ディレクトリ | - |
| RestoreTime | DateTime | No | ポイントインタイムリカバリの目標時刻 | デフォルト: 1年後 |
| NoRecovery | switch | No | RESTORINGステートで終了 | - |
| WithReplace | switch | No | 既存データベースを置換 | - |
| VerifyOnly | switch | No | リストアを実行せず検証のみ | OutputScriptOnlyと排他 |
| OutputScriptOnly | switch | No | T-SQLスクリプトのみ生成 | VerifyOnlyと排他 |
| MaintenanceSolutionBackup | switch | No | Ola Hallengrenフォルダ構造に最適化 | - |
| FileMapping | hashtable | No | ファイル配置のカスタムマッピング | - |
| TrustDbBackupHistory | switch | No | バックアップヘッダー検証をスキップ | - |
| Continue | switch | No | 既存のリストア操作を継続 | - |
| Recover | switch | No | RESTORINGデータベースをオンラインに | Recoveryパラメータセット |
| StorageCredential | string | No | Azure/S3ストレージ資格情報名 | - |
| PageRestore | object | No | ページリストア対象（Get-DbaSuspectPage出力） | PageRestoreパラメータセット |
| その他多数 | - | - | 詳細はコードリーディングガイド参照 | - |

### 入力データソース

バックアップファイル（ローカル、UNC、Azure URL、S3 URL）

## 出力仕様

### 出力データ

**-OutputScriptOnly 使用時**

| 項目名 | 型 | 説明 |
|--------|-----|------|
| (string) | string | T-SQL RESTOREステートメント |

**-Recover パラメータセット使用時**

| 項目名 | 型 | 説明 |
|--------|-----|------|
| SqlInstance | string | SQL Serverインスタンス名 |
| DatabaseName | string | リカバリしたデータベース名 |
| RestoreComplete | bool | リカバリ成功フラグ |
| Scripts | string | 実行したRESTORE文 |

**通常リストア時**

Invoke-DbaAdvancedRestoreに委譲され、その出力が返される。

### 出力先

- PowerShellパイプライン
- SQL Serverデータベース（リストア結果）

## 処理フロー

### 処理シーケンス

```
1. パラメータ検証
   └─ 排他パラメータチェック、ManagedInstance制限チェック
2. バックアップ情報取得
   └─ Get-DbaBackupInformationでバックアップ履歴を構築
3. バックアップ情報フォーマット
   └─ Format-DbaBackupInformationでファイルパス調整
4. バックアップ選択
   └─ Select-DbaBackupInformationでリストアチェーン選択
5. バックアップ検証
   └─ Test-DbaBackupInformationで整合性確認
6. リストア実行
   └─ Invoke-DbaAdvancedRestoreでリストアコマンド実行
7. 後処理
   └─ ページリストア時のテールログ処理など
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[パラメータ検証]
    B --> C{パラメータセット判定}
    C -->|Restore| D[Get-DbaBackupInformation]
    C -->|Recovery| E[RESTORE WITH RECOVERY実行]
    D --> F[Format-DbaBackupInformation]
    F --> G[Select-DbaBackupInformation]
    G --> H[Test-DbaBackupInformation]
    H --> I{検証成功?}
    I -->|No| J[Stop-Function]
    I -->|Yes| K[Invoke-DbaAdvancedRestore]
    K --> L{PageRestore?}
    L -->|Yes| M[テールログ処理]
    L -->|No| N[終了]
    M --> O[Restore-DbaDatabase -Recover]
    O --> N
    E --> N
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-45-01 | デフォルトディレクトリ | UseDestinationDefaultDirectoriesが暗黙的に有効 | 他のパス指定なし時 |
| BR-45-02 | パラメータ排他 | FileMapping/ReuseSourceFolderStructure/DestinationDataDirectoryは排他 | 複数指定時 |
| BR-45-03 | リカバリモード | NoRecovery時はデータベースはRESTORINGステートのまま | NoRecovery指定時 |
| BR-45-04 | ReplaceDbNameInFile | DatabaseNameパラメータが必須 | ReplaceDbNameInFile指定時 |
| BR-45-05 | KeepCDC制限 | NoRecoveryやStandbyと同時使用不可 | KeepCDC指定時 |

### 計算ロジック

特に複雑な計算ロジックは、依存コマンド（Select-DbaBackupInformation等）に委譲される。

## データベース操作仕様

### 操作別データベース影響一覧

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| リストア | ターゲットデータベース | RESTORE | バックアップからデータベースを復元 |
| リカバリ | ターゲットデータベース | RESTORE WITH RECOVERY | RESTORINGからオンラインに |

### テーブル別操作詳細

データベースレベルの操作であり、特定テーブルへの操作ではない。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| ConnectionError | 接続エラー | SQL Serverへの接続失敗 | Stop-Functionで終了 |
| InvalidArgument | パラメータエラー | 排他パラメータ同時指定 | Stop-Functionで終了 |
| - | バックアップなし | 対象バックアップが見つからない | 警告出力で終了 |
| - | 検証失敗 | LSNチェーンエラー等 | Stop-Functionで終了 |

### リトライ仕様

本機能にはリトライ機構は実装されていない。

## トランザクション仕様

SQL ServerのRESTORE DATABASE操作はトランザクション内で自動管理される。

## パフォーマンス要件

- MaxTransferSize、Blocksize、BufferCountでI/Oパフォーマンスを調整可能
- StatementTimeoutで長時間リストアのタイムアウトを制御（デフォルト: 無制限）

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

- dbcreator固定サーバーロールまたはsysadminが必要
- バックアップファイルへのSQL Serverサービスアカウントのアクセス権が必要
- StorageCredentialでAzure/S3への認証を管理

## 備考

- SQL Server 2000の場合、TrustDbBackupHistoryが自動的に有効化される
- Managed Instanceでは一部パラメータが使用不可

---

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

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

### 推奨読解順序

#### Step 1: パラメータセットを理解する

複数のパラメータセットの構造を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Restore-DbaDatabase.ps1 | `public/Restore-DbaDatabase.ps1` | 447-504行目のparam定義 |

**読解のコツ**: DefaultParameterSetName = "Restore"。Restore、RestorePage、Recoveryの3つのパラメータセットが存在する。

#### Step 2: 初期検証を理解する

beginブロックでのパラメータ検証を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Restore-DbaDatabase.ps1 | `public/Restore-DbaDatabase.ps1` | 505-631行目のbeginブロック |

**主要処理フロー**:
- **509-515行目**: Connect-DbaInstance接続
- **517-527行目**: ManagedInstance制限チェック
- **529-614行目**: 各種パラメータ排他チェック

#### Step 3: バックアップ履歴構築を理解する

processブロックでのバックアップ情報収集を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Restore-DbaDatabase.ps1 | `public/Restore-DbaDatabase.ps1` | 632-767行目のprocessブロック |

**主要処理フロー**:
- **637-648行目**: SQL Server 2000の特別処理
- **654-691行目**: TrustDbBackupHistory時のBackupHistory構築
- **693-717行目**: Get-DbaBackupInformation呼び出し

#### Step 4: リストア実行を理解する

endブロックでのリストア処理を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | Restore-DbaDatabase.ps1 | `public/Restore-DbaDatabase.ps1` | 768-928行目のendブロック |

**主要処理フロー**:
- **804行目**: Format-DbaBackupInformation呼び出し
- **823行目**: Select-DbaBackupInformation呼び出し
- **844行目**: Test-DbaBackupInformation呼び出し
- **899行目**: Invoke-DbaAdvancedRestore呼び出し

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

```
Restore-DbaDatabase
    │
    ├─ Connect-DbaInstance
    │      └─ SQL Server接続確立
    │
    ├─ Get-DbaBackupInformation
    │      └─ バックアップファイル情報取得
    │
    ├─ Format-DbaBackupInformation
    │      └─ ファイルパスリマッピング
    │
    ├─ Select-DbaBackupInformation
    │      └─ リストアチェーン選択
    │
    ├─ Test-DbaBackupInformation
    │      └─ LSNチェーン検証
    │
    └─ Invoke-DbaAdvancedRestore
           └─ RESTORE DATABASE実行
```

### データフロー図

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

Path ───────────────────────► Get-DbaBackupInformation ─────────►
SqlInstance ────────────────►         │
                                      ▼
                              BackupHistory オブジェクト
                                      │
                                      ▼
                              Format-DbaBackupInformation ──────►
DatabaseName ───────────────►         │
DestinationDataDirectory ───►         │
                                      ▼
                              フォーマット済みBackupHistory
                                      │
                                      ▼
                              Select-DbaBackupInformation ──────►
RestoreTime ────────────────►         │
                                      ▼
                              選択されたリストアチェーン
                                      │
                                      ▼
                              Test-DbaBackupInformation ────────►
                                      │
                                      ▼
                              検証済みBackupHistory
                                      │
                                      ▼
                              Invoke-DbaAdvancedRestore ───► リストア実行
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Restore-DbaDatabase.ps1 | `public/Restore-DbaDatabase.ps1` | ソース | メイン機能実装 |
| Restore-DbaDatabase.Tests.ps1 | `tests/Restore-DbaDatabase.Tests.ps1` | テスト | Pesterテストコード |
| Get-DbaBackupInformation.ps1 | `public/Get-DbaBackupInformation.ps1` | ソース | バックアップ情報取得 |
| Format-DbaBackupInformation.ps1 | `public/Format-DbaBackupInformation.ps1` | ソース | パスリマッピング |
| Select-DbaBackupInformation.ps1 | `public/Select-DbaBackupInformation.ps1` | ソース | チェーン選択 |
| Test-DbaBackupInformation.ps1 | `public/Test-DbaBackupInformation.ps1` | ソース | 検証処理 |
| Invoke-DbaAdvancedRestore.ps1 | `public/Invoke-DbaAdvancedRestore.ps1` | ソース | リストア実行 |
