# 機能設計書 649-Remove-DbaDbFileGroup

## 概要

本ドキュメントは、SQL Serverデータベースから空のファイルグループを削除するdbatools PowerShellコマンド「Remove-DbaDbFileGroup」の機能設計書です。

### 本機能の処理概要

Remove-DbaDbFileGroupは、指定されたデータベースから空のファイルグループを削除するコマンドです。ファイルグループにファイルが含まれている場合は削除できません。

**業務上の目的・背景**：データベースの再編成、ストレージ構成の変更、または不要になったファイルグループの整理において、未使用のファイルグループを削除する必要があります。本機能により、ファイルグループの削除を自動化し、適切なバリデーション（空であることの確認）を行った上で安全に削除できます。

**機能の利用シーン**：
- データベース構成のクリーンアップ
- ストレージ移行後の不要ファイルグループ削除
- テスト環境の整理
- データベース統合後のファイルグループ整理
- 複数データベースからの一括ファイルグループ削除

**主要な処理内容**：
1. パラメータ検証（SqlInstance時はDatabase必須）
2. 対象データベースまたはファイルグループオブジェクトの取得
3. ファイルグループの存在確認
4. ファイルグループが空であることの確認
5. FileGroup.Drop() による削除実行

**関連システム・外部連携**：
- SQL Serverインスタンス（SMO）

**権限による制御**：対象データベースに対するALTER DATABASE権限が必要です。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | CLI専用 | 主機能 | コマンドライン実行のみ |

## 機能種別

データ削除（DDL DROP） / ストレージ構成管理

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | 条件付き | 対象SQL Serverインスタンス | InputObject未使用時に必要 |
| SqlCredential | PSCredential | No | SQL Server接続用資格情報 | - |
| Database | string[] | 条件付き | 対象データベース名 | SqlInstance使用時に必要 |
| FileGroup | string[] | 条件付き | 削除するファイルグループ名 | Database使用時に必要 |
| InputObject | object[] | No | パイプラインからのデータベースまたはファイルグループオブジェクト | - |
| EnableException | switch | No | エラー時に例外をスロー | - |

### 入力データソース

- パイプライン入力:
  - Get-DbaDatabase からのデータベースオブジェクト
  - Get-DbaDbFileGroup からのファイルグループオブジェクト
- 直接パラメータ指定

## 出力仕様

### 出力データ

本コマンドは成功時に出力を返しません。操作の結果はShouldProcess（WhatIf/Confirm）またはエラーメッセージで伝達されます。

### 出力先

なし（削除操作のため）

## 処理フロー

### 処理シーケンス

```
1. パラメータ検証
   └─ SqlInstance指定時はDatabase必須チェック

2. 入力オブジェクトの収集
   ├─ SqlInstance指定時: Get-DbaDatabase で取得
   └─ InputObject: そのまま使用

3. 削除対象ファイルグループの特定
   ├─ Databaseオブジェクト入力時:
   │   ├─ FileGroup必須チェック
   │   └─ FileGroups[$FileGroup]を収集
   └─ FileGroupオブジェクト入力時:
       └─ そのまま使用

4. 各ファイルグループの削除処理
   ├─ 空でないファイルグループ: Stop-Function でスキップ
   └─ 空のファイルグループ: Drop() 実行
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{SqlInstance指定?}
    B -->|Yes| C{Database指定?}
    C -->|No| D[エラー終了]
    C -->|Yes| E[Get-DbaDatabase]
    B -->|No| F[InputObject使用]
    E --> G[InputObjectに追加]
    F --> H[オブジェクトループ]
    G --> H
    H --> I{オブジェクトの型?}
    I -->|Database| J{FileGroup指定?}
    J -->|No| K[エラー: FileGroup必須]
    J -->|Yes| L[FileGroup存在確認]
    L --> M{存在?}
    M -->|No| N[エラー: 存在しない]
    M -->|Yes| O[削除リストに追加]
    I -->|FileGroup| O
    K --> P{次オブジェクト?}
    N --> P
    O --> P
    P -->|Yes| H
    P -->|No| Q[削除リストループ]
    Q --> R{ファイルあり?}
    R -->|Yes| S[エラー: 空でない]
    R -->|No| T{ShouldProcess?}
    S --> U{次FG?}
    T -->|No| U
    T -->|Yes| V[FileGroup.Drop]
    V --> W{成功?}
    W -->|No| X[エラー出力]
    W -->|Yes| U
    X --> U
    U -->|Yes| Q
    U -->|No| Y[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | 空チェック | ファイルグループ内にファイルがある場合は削除不可 | 常時 |
| BR-002 | 存在チェック | 指定されたファイルグループがデータベースに存在しない場合はエラー | 常時 |
| BR-003 | FileGroup必須 | Databaseオブジェクト入力時はFileGroupパラメータが必須 | Databaseオブジェクト入力時 |

### 計算ロジック

特になし

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| ファイルグループ削除 | sys.filegroups | DDL DROP | ALTER DATABASE REMOVE FILEGROUP相当 |

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

#### sys.filegroups（メタデータ）

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| DELETE | - | name = FileGroupパラメータ値 | SMO経由で自動 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ValidationError | SqlInstance指定時にDatabase未指定 | Databaseを指定 |
| - | ValidationError | Databaseオブジェクト入力時にFileGroup未指定 | FileGroupを指定 |
| - | NotFoundError | 指定ファイルグループが存在しない | 正しいファイルグループ名を指定 |
| - | NotEmptyError | ファイルグループにファイルが含まれる | 先にファイルを削除/移動 |
| - | DropError | 削除操作失敗 | 権限と依存関係を確認 |

### リトライ仕様

リトライなし（ファイルグループ単位でContinueしてスキップ）

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

SMO FileGroup.Drop() はDDL操作として暗黙的コミット

## パフォーマンス要件

- 通常100ms以下でファイルグループ削除完了

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

- 対象データベースに対するALTER DATABASE権限が必要
- ShouldProcess対応（WhatIf/Confirm）
- ConfirmImpact = "High"（確認プロンプト表示）

## 備考

- ファイルを含むファイルグループを削除するには、先にRemove-DbaDbFileでファイルを削除する必要がある
- PRIMARYファイルグループは削除不可

---

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

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

### 推奨読解順序

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

入力と処理の対象となるオブジェクト型を理解します。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Remove-DbaDbFileGroup.ps1 | `public/Remove-DbaDbFileGroup.ps1` | L80, L97, L114のオブジェクト型判定 |

**読解のコツ**: InputObjectはDatabaseオブジェクトまたはFileGroupオブジェクトの両方を受け入れます。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Remove-DbaDbFileGroup.ps1 | `public/Remove-DbaDbFileGroup.ps1` | processブロック全体の流れ |

**主要処理フロー**:
1. **86-89行目**: SqlInstance時のDatabase必須チェック
2. **91-93行目**: Get-DbaDatabase でデータベース取得
3. **97-117行目**: 入力オブジェクトの型判定と削除リスト構築
4. **119-132行目**: 削除処理ループ

#### Step 3: 削除前バリデーションを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Remove-DbaDbFileGroup.ps1 | `public/Remove-DbaDbFileGroup.ps1` | L99-112の存在確認、L121-123の空チェック |

**主要処理フロー**:
- **99-103行目**: Databaseオブジェクト時のFileGroup必須チェック
- **105-108行目**: ファイルグループ存在確認
- **121-123行目**: ファイルグループが空であることの確認（Files.Count > 0）

#### Step 4: 削除処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | Remove-DbaDbFileGroup.ps1 | `public/Remove-DbaDbFileGroup.ps1` | L125-131の削除処理 |

**主要処理フロー**:
- **125行目**: ShouldProcess確認
- **127行目**: FileGroup.Drop() 実行
- **128-130行目**: エラーハンドリング

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

```
Remove-DbaDbFileGroup
    │
    ├─ Get-DbaDatabase（データベースオブジェクト取得）
    │      └─ Connect-DbaInstance
    │
    ├─ 型判定
    │      ├─ Microsoft.SqlServer.Management.Smo.Database
    │      └─ Microsoft.SqlServer.Management.Smo.FileGroup
    │
    └─ SMO FileGroup操作
           └─ FileGroup.Drop()
```

### データフロー図

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

SqlInstance ──────────┐
                      │
Database ─────────────┼──▶ Get-DbaDatabase ─────────┐
                      │                              │
FileGroup ────────────┤                              ▼
                      │    ┌───────────────────────────────┐
InputObject ──────────┘    │ 型判定                        │
(Database or              │ ├─ Database → FileGroups取得   │
 FileGroup)               │ └─ FileGroup → そのまま使用    │
                           └───────────────────────────────┘
                                         │
                                         ▼
                           ┌───────────────────────────────┐
                           │ バリデーション                 │
                           │ ├─ 存在確認                   │
                           │ └─ 空チェック                 │
                           └───────────────────────────────┘
                                         │
                                         ▼
                                FileGroup.Drop()
                                         │
                                         ▼
                                    (出力なし)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Remove-DbaDbFileGroup.ps1 | `public/Remove-DbaDbFileGroup.ps1` | ソース | メインコマンド実装 |
| Get-DbaDatabase.ps1 | `public/Get-DbaDatabase.ps1` | ソース | データベースオブジェクト取得 |
| Get-DbaDbFileGroup.ps1 | `public/Get-DbaDbFileGroup.ps1` | ソース | ファイルグループオブジェクト取得 |
| New-DbaDbFileGroup.ps1 | `public/New-DbaDbFileGroup.ps1` | ソース | ファイルグループ作成 |
| Set-DbaDbFileGroup.ps1 | `public/Set-DbaDbFileGroup.ps1` | ソース | ファイルグループ設定変更 |
| Connect-DbaInstance.ps1 | `public/Connect-DbaInstance.ps1` | ソース | SQL Server接続 |
