# 機能設計書 43-Remove-DbaBackup

## 概要

本ドキュメントは、保持ポリシーに基づいてSQL Serverバックアップファイルをディスクから削除するdbatools PowerShellコマンド `Remove-DbaBackup` の機能設計書である。

### 本機能の処理概要

この機能は、バックアップディレクトリを再帰的に検索し、指定された保持期間より古いSQL Serverバックアップファイルを削除する。バックアップファイルの拡張子とアーカイブビットによるフィルタリングが可能で、空になったフォルダの自動削除もサポートする。

**業務上の目的・背景**：バックアップファイルは時間とともに蓄積され、ストレージ容量を圧迫する。手動でのクリーンアップは労力がかかり、ミスも発生しやすい。SQL Serverメンテナンスプランのバックアップクリーンアップ機能に代わる、より柔軟で制御可能なバックアップ削除機能を提供する。

**機能の利用シーン**：
- 定期的なバックアップファイルクリーンアップのスケジュール実行
- ストレージ容量逼迫時の緊急クリーンアップ
- バックアップ種別ごとの異なる保持ポリシー適用
- テープアーカイブ後の安全なファイル削除

**主要な処理内容**：
1. 指定されたルートディレクトリの検証
2. Find-DbaBackupを使用した対象ファイルの検索
3. 保持期間、拡張子、アーカイブビットに基づくフィルタリング
4. 対象ファイルの削除実行
5. 空フォルダの検出と削除（オプション）

**関連システム・外部連携**：ローカルファイルシステム、ネットワーク共有へのアクセス

**権限による制御**：対象ファイル/フォルダへの削除権限が必要。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | - | - | CLIベースの運用コマンド |

## 機能種別

ファイル削除 / メンテナンス処理

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| Path | string | Yes | バックアップファイルのルートディレクトリ | - |
| BackupFileExtension | string | Yes | 削除対象の拡張子（bak/trn/dif等） | ピリオド開始の場合は警告 |
| RetentionPeriod | string | Yes | 保持期間（例: 48h, 7d, 4w, 1m） | 数値+単位形式 |
| CheckArchiveBit | switch | No | アーカイブビットがクリアされたファイルのみ削除 | - |
| RemoveEmptyBackupFolder | switch | No | 空になったフォルダを削除 | - |
| EnableException | switch | No | 例外を有効にするスイッチ | - |
| WhatIf | switch | No | 実行せずに何が起きるか表示 | - |
| Confirm | switch | No | 確認プロンプト表示 | - |

### 入力データソース

ファイルシステム（バックアップファイル）

## 出力仕様

### 出力データ

本機能はオブジェクトを返さない。ファイルおよびフォルダの削除操作を実行する。

### 出力先

- ファイルシステム（ファイル/フォルダの削除）
- コンソール（-WhatIf時の操作内容表示）

## 処理フロー

### 処理シーケンス

```
1. パラメータ検証
   └─ 拡張子のピリオド開始チェックと警告
2. バックアップファイル検索
   └─ Find-DbaBackupで対象ファイルを特定
3. 各ファイルに対して削除処理
   └─ ShouldProcessによる確認後、Remove-Item実行
4. 空フォルダ削除（オプション）
   └─ Get-ChildItemで空フォルダを検出
   └─ 深い階層から順に削除
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[パラメータ検証]
    B --> C{拡張子がピリオド開始?}
    C -->|Yes| D[警告出力]
    C -->|No| E[Find-DbaBackup実行]
    D --> E
    E --> F{対象ファイルあり?}
    F -->|No| G[終了]
    F -->|Yes| H{各ファイルループ}
    H --> I{ShouldProcess確認}
    I -->|Yes| J[Remove-Item実行]
    I -->|No| H
    J --> K{削除成功?}
    K -->|No| L[警告出力]
    K -->|Yes| H
    L --> H
    H --> M{全ファイル処理完了?}
    M -->|No| H
    M -->|Yes| N{RemoveEmptyBackupFolder?}
    N -->|No| G
    N -->|Yes| O[空フォルダ検索]
    O --> P{空フォルダループ}
    P --> Q{ShouldProcess確認}
    Q -->|Yes| R[フォルダ削除]
    Q -->|No| P
    R --> P
    P --> G
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-43-01 | 保持期間形式 | 数値+単位（h=時間, d=日, w=週, m=月） | RetentionPeriod指定時 |
| BR-43-02 | 拡張子形式 | ピリオドなしで指定（自動で付与される） | BackupFileExtension指定時 |
| BR-43-03 | アーカイブビットチェック | テープ等にアーカイブ済みファイルのみ削除 | CheckArchiveBit有効時 |
| BR-43-04 | 空フォルダ削除順序 | 深い階層から順に削除（親フォルダを先に削除しない） | RemoveEmptyBackupFolder有効時 |

### 計算ロジック

保持期間の計算はFind-DbaBackupに委譲される。

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

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

本機能はデータベース操作を行わない（ファイルシステム操作のみ）。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ファイル削除失敗 | アクセス権限不足、ファイルロック | 警告出力して継続 |
| - | フォルダ列挙失敗 | アクセス権限不足 | 警告出力して継続 |
| - | フォルダ削除失敗 | アクセス権限不足、空でない | 警告出力して継続 |

### リトライ仕様

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

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

ファイルシステム操作のため、トランザクション管理は不要。各ファイル削除は独立して実行される。

## パフォーマンス要件

- 大量ファイル処理時は-WhatIfで事前確認を推奨
- 再帰検索のため、深いディレクトリ構造では時間がかかる可能性あり

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

- 実行ユーザーがファイル/フォルダの削除権限を持つ必要がある
- SupportsShouldProcessにより、-WhatIfと-Confirmオプションで安全性を確保
- アーカイブビットチェックにより、バックアップされていないファイルの誤削除を防止

## 備考

- SQL Serverメンテナンスプランのバックアップクリーンアップ機能の代替として使用可能
- Find-DbaBackupコマンドに依存している

---

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

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

### 推奨読解順序

#### Step 1: パラメータ定義を理解する

入力パラメータの構造を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Remove-DbaBackup.ps1 | `public/Remove-DbaBackup.ps1` | 85-97行目のparam定義 |

**読解のコツ**: SupportsShouldProcessが有効なため、WhatIfとConfirmが自動的に利用可能になる。

#### Step 2: 入力検証処理を理解する

拡張子のバリデーション処理を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Remove-DbaBackup.ps1 | `public/Remove-DbaBackup.ps1` | 98-103行目のbeginブロック |

**主要処理フロー**:
- **100-101行目**: 拡張子がピリオドで始まる場合の警告出力

#### Step 3: ファイル削除処理を理解する

Find-DbaBackupとRemove-Itemの連携を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Remove-DbaBackup.ps1 | `public/Remove-DbaBackup.ps1` | 104-118行目のファイル削除処理 |

**主要処理フロー**:
- **107行目**: Find-DbaBackup呼び出し
- **108-117行目**: ForEach-Objectでの削除処理
- **110行目**: ShouldProcess確認
- **112行目**: Remove-Item -Force実行

#### Step 4: 空フォルダ削除処理を理解する

RemoveEmptyBackupFolderオプションの処理を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | Remove-DbaBackup.ps1 | `public/Remove-DbaBackup.ps1` | 120-149行目の空フォルダ削除処理 |

**主要処理フロー**:
- **122行目**: Get-ChildItem -Directoryで全ディレクトリ取得
- **123行目**: Sort-Object -Descendingで深い階層から処理
- **127行目**: Get-ChildItem -Forceでフォルダ内容確認
- **131-132行目**: 空の場合は削除候補として返す
- **137行目**: ShouldProcess確認後削除

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

```
Remove-DbaBackup
    │
    ├─ Find-DbaBackup
    │      └─ 保持期間・拡張子でフィルタしたファイル一覧取得
    │
    ├─ Remove-Item
    │      └─ ファイル削除
    │
    └─ Get-ChildItem / Remove-Item
           └─ 空フォルダ検出と削除
```

### データフロー図

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

Path ───────────────────────► Find-DbaBackup ───────────────────►
BackupFileExtension ────────►         │
RetentionPeriod ────────────►         │
CheckArchiveBit ────────────►         │
                                      ▼
                              対象ファイル一覧
                                      │
                                      ▼
                              ShouldProcess確認
                                      │
                                      ▼
                              Remove-Item ─────────► ファイル削除
                                      │
                                      ▼
                              {RemoveEmptyBackupFolder?}
                                      │
                                      ▼
                              Get-ChildItem -Directory
                                      │
                                      ▼
                              空フォルダ検出
                                      │
                                      ▼
                              Remove-Item ─────────► フォルダ削除
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Remove-DbaBackup.ps1 | `public/Remove-DbaBackup.ps1` | ソース | メイン機能実装 |
| Remove-DbaBackup.Tests.ps1 | `tests/Remove-DbaBackup.Tests.ps1` | テスト | Pesterテストコード |
| Find-DbaBackup.ps1 | `public/Find-DbaBackup.ps1` | ソース | バックアップファイル検索（依存コマンド） |
