# 機能設計書 281-Remove-DbaDbSnapshot

## 概要

本ドキュメントは、SQL Server データベーススナップショットを削除する Remove-DbaDbSnapshot コマンドの機能設計書です。

### 本機能の処理概要

Remove-DbaDbSnapshot は、SQL Server インスタンス上のデータベーススナップショットを削除（DROP DATABASE）する PowerShell コマンドです。

**業務上の目的・背景**：データベーススナップショットはポイントインタイムでの読み取り専用データベースコピーとして使用されますが、時間が経過すると不要になったスナップショットがディスク容量を消費し続けます。本機能は、レポーティング、テスト、リカバリ目的で作成された古いスナップショットをクリーンアップし、ストレージリソースを効率的に管理するために必要です。また、メンテナンスウィンドウでの一括削除や、特定のデータベースに関連するスナップショットのみを選択的に削除する要件に対応します。

**機能の利用シーン**：
- 定期メンテナンスでの古いスナップショットのクリーンアップ
- テスト環境でのスナップショット一括削除
- 特定のソースデータベースに紐づくスナップショットの選択的削除
- サーバー移行・廃止時の全スナップショット削除
- ディスク容量逼迫時の緊急対応

**主要な処理内容**：
1. 対象 SQL Server インスタンスへの接続確立
2. 削除対象スナップショットの特定（名前、ソースデータベース、全件指定など複数の選択方式）
3. アクティブ接続のチェックと Force オプションによる強制切断
4. DROP DATABASE ステートメントの実行
5. 処理結果のパイプライン出力

**関連システム・外部連携**：SQL Server Management Objects (SMO) を介して SQL Server と連携します。Get-DbaDbSnapshot コマンドと組み合わせて使用されることが多く、パイプライン入力をサポートします。

**権限による制御**：データベースの削除権限（db_owner ロールまたは dbcreator サーバーロール）が必要です。Force パラメータ使用時は、接続を切断するための追加権限（ALTER ANY CONNECTION）が必要です。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | SSMS Object Explorer | 参照画面 | スナップショット確認 |
| - | PowerShell Console | 主画面 | コマンド実行 |

## 機能種別

削除操作（DROP DATABASE）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | No | 対象 SQL Server インスタンス | 有効なインスタンス名 |
| SqlCredential | PSCredential | No | 代替認証情報 | - |
| Database | string[] | No | スナップショットのソースデータベース名 | - |
| ExcludeDatabase | string[] | No | 除外するソースデータベース名 | - |
| Snapshot | string[] | No | 削除するスナップショット名 | - |
| InputObject | Microsoft.SqlServer.Management.Smo.Database[] | No | パイプライン入力されたスナップショットオブジェクト | DatabaseSnapshotBaseName が存在すること |
| AllSnapshots | switch | No | 全スナップショット削除フラグ | - |
| Force | switch | No | アクティブ接続の強制切断 | - |
| EnableException | switch | No | 例外スロー有効化 | - |

### 入力データソース

- PowerShell コマンドライン引数
- Get-DbaDbSnapshot からのパイプライン入力
- SQL Server インスタンスのスナップショットメタデータ

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | SQL Server ホスト名 |
| InstanceName | string | インスタンス名 |
| SqlInstance | string | 完全修飾インスタンス名 |
| Database (Name) | string | 削除されたスナップショット名 |
| Status | string | 処理結果（Dropped / エラーメッセージ） |

### 出力先

PowerShell パイプライン（PSCustomObject）

## 処理フロー

### 処理シーケンス

```
1. パラメータ検証
   └─ Snapshot, Database, AllSnapshots, ExcludeDatabase, InputObject のいずれかが指定されているか確認
2. SQL Server インスタンスへの接続
   └─ Connect-DbaInstance を使用
3. 削除対象スナップショットの取得
   └─ Get-DbaDbSnapshot で対象を特定
4. 各スナップショットに対して削除処理
   ├─ スナップショットかどうかの検証（DatabaseSnapshotBaseName の存在確認）
   ├─ Force パラメータの場合：Remove-DbaDatabase を呼び出し
   └─ 通常の場合：$db.Drop() メソッドを実行
5. 結果オブジェクトの出力
   └─ 成功時は "Dropped"、失敗時はエラーメッセージを Status に設定
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{パラメータ検証}
    B -->|パラメータ不足| C[エラー終了]
    B -->|OK| D[SqlInstance ループ開始]
    D --> E[Connect-DbaInstance]
    E --> F[Get-DbaDbSnapshot で対象取得]
    F --> G[InputObject ループ開始]
    G --> H{DatabaseSnapshotBaseName<br/>存在確認}
    H -->|スナップショットでない| I[スキップ]
    H -->|OK| J{Force?}
    J -->|Yes| K[Remove-DbaDatabase 呼び出し]
    J -->|No| L{ShouldProcess?}
    L -->|No| G
    L -->|Yes| M[db.Drop 実行]
    M --> N{成功?}
    N -->|Yes| O[Status=Dropped 出力]
    N -->|No| P[Status=エラー 出力]
    K --> G
    O --> G
    P --> G
    I --> G
    G -->|完了| Q[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | パラメータ必須チェック | Snapshot, Database, AllSnapshots, ExcludeDatabase, InputObject のいずれかが必要 | 常時 |
| BR-002 | スナップショット検証 | DatabaseSnapshotBaseName が存在しないオブジェクトはスキップ | 各スナップショット処理時 |
| BR-003 | 強制削除 | Force パラメータでアクティブ接続を切断して削除 | Force 指定時 |

### 計算ロジック

特になし

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| スナップショット削除 | sys.databases | DELETE | DROP DATABASE によるスナップショット削除 |

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

#### sys.databases

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| DELETE | name | 指定されたスナップショット名 | DROP DATABASE 実行 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | パラメータ不足 | 必須パラメータが指定されていない | Snapshot, Database, AllSnapshots 等を指定 |
| - | 接続エラー | SQL Server に接続できない | インスタンス名と認証情報を確認 |
| - | 削除失敗 | アクティブ接続がある | Force パラメータを使用 |
| - | 非スナップショット | 指定オブジェクトがスナップショットでない | Get-DbaDbSnapshot で確認 |

### リトライ仕様

リトライは実装されていません。失敗時はエラーメッセージを Status に設定して続行します。

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

DROP DATABASE は暗黙的トランザクションで実行されます。各スナップショットの削除は独立して処理されるため、一部の削除に失敗しても他のスナップショットの削除は継続されます。

## パフォーマンス要件

特に定義されていません。スナップショットの削除はディスク上のスパースファイルの削除を伴うため、ストレージ I/O に依存します。

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

- SQL Server 認証または Windows 認証を使用
- データベース削除権限（db_owner または dbcreator）が必要
- Force 使用時は ALTER ANY CONNECTION 権限が必要
- SqlCredential パラメータで資格情報を安全に受け渡し

## 備考

- SQL Server 2005 以降をサポート
- SupportsShouldProcess を実装（-WhatIf, -Confirm 対応）
- ConfirmImpact は High に設定

---

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

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

### 推奨読解順序

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

パイプラインで受け渡されるオブジェクトの構造を理解することが重要です。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Remove-DbaDbSnapshot.ps1 | `public/Remove-DbaDbSnapshot.ps1` | 134行目: 出力オブジェクトのデフォルトプロパティ定義 |

**読解のコツ**: PSCustomObject の構造と Select-DefaultView による表示プロパティの制御を確認します。

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

関数の開始点とパラメータバインディングを確認します。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Remove-DbaDbSnapshot.ps1 | `public/Remove-DbaDbSnapshot.ps1` | パラメータ定義とパイプライン入力の受け付け |

**主要処理フロー**:
1. **119-130行目**: パラメータ定義（SqlInstance, InputObject, AllSnapshots 等）
2. **131-135行目**: begin ブロックで Force 時の ConfirmPreference 設定とデフォルトプロパティ定義
3. **137-140行目**: パラメータ検証

#### Step 3: 削除処理の実装を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Remove-DbaDbSnapshot.ps1 | `public/Remove-DbaDbSnapshot.ps1` | 削除処理のメインロジック |

**主要処理フロー**:
- **143-151行目**: SqlInstance からスナップショットを取得
- **153-158行目**: スナップショット検証（DatabaseSnapshotBaseName チェック）
- **160-161行目**: Force パラメータ時の Remove-DbaDatabase 呼び出し
- **163-186行目**: 通常の Drop() メソッド実行と結果出力

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

```
Remove-DbaDbSnapshot
    │
    ├─ Connect-DbaInstance
    │      └─ SQL Server 接続確立
    │
    ├─ Get-DbaDbSnapshot
    │      └─ スナップショット一覧取得
    │
    └─ 各スナップショットに対して
           ├─ [Force] Remove-DbaDatabase
           │      └─ アクティブ接続切断 + 削除
           └─ [通常] $db.Drop()
                  └─ SMO による削除
```

### データフロー図

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

SqlInstance ────────┐
                    │
Database ───────────┼──▶ Get-DbaDbSnapshot ──▶ スナップショット一覧
                    │            │
Snapshot ───────────┤            ▼
                    │     各スナップショット
AllSnapshots ───────┤            │
                    │            ▼
InputObject ────────┘     Drop() / Remove-DbaDatabase
                                 │
                                 ▼
                         PSCustomObject ──────────▶ パイプライン出力
                         (ComputerName,
                          InstanceName,
                          SqlInstance,
                          Database,
                          Status)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Remove-DbaDbSnapshot.ps1 | `public/Remove-DbaDbSnapshot.ps1` | ソース | メイン関数実装 |
| Remove-DbaDbSnapshot.Tests.ps1 | `tests/Remove-DbaDbSnapshot.Tests.ps1` | テスト | ユニット・統合テスト |
| Get-DbaDbSnapshot.ps1 | `public/Get-DbaDbSnapshot.ps1` | ソース | スナップショット取得（依存） |
| Remove-DbaDatabase.ps1 | `public/Remove-DbaDatabase.ps1` | ソース | Force 時のデータベース削除（依存） |
| Connect-DbaInstance.ps1 | `public/Connect-DbaInstance.ps1` | ソース | SQL Server 接続（依存） |
