# 機能設計書 18-Remove-DbaAgDatabase

## 概要

本ドキュメントは、SQL Server可用性グループからデータベースを削除するRemove-DbaAgDatabaseコマンドの機能設計書です。

### 本機能の処理概要

Remove-DbaAgDatabaseは、可用性グループからデータベースを削除し、レプリケーションと高可用性保護を停止するPowerShellコマンドレットです。データベースは可用性グループから削除されますが、各レプリカ上の実際のデータベースファイルは保持されます。

**業務上の目的・背景**：データベースのデコミッショニング、メンテナンスウィンドウでのAGメンバーシップ再構成、またはレプリケーション問題のトラブルシューティング時に、データベースをAGから削除する必要があります。このコマンドは、AGからデータベースを安全に削除しながら、各レプリカ上の実際のデータベースを保持することで、必要に応じて再参加やスタンドアロン使用を可能にします。

**機能の利用シーン**：
- データベースのデコミッショニング
- AGメンバーシップの再構成
- レプリケーション問題のトラブルシューティング
- 一時的なAG除外（メンテナンス目的）
- AGから別AGへのデータベース移動準備

**主要な処理内容**：
1. 指定されたSQL Serverインスタンスに接続
2. 対象データベースを含む可用性グループを取得
3. AGからデータベースを削除（Drop()メソッド）
4. 削除結果をPSCustomObjectで出力

**関連システム・外部連携**：
- SQL Server SMO (Server Management Objects)
- SQL Server可用性グループインフラストラクチャ
- Windows Server Failover Clustering (WSFC)

**権限による制御**：対象可用性グループに対するALTER AVAILABILITY GROUP権限、またはsysadmin固定サーバーロールのメンバーシップが必要です。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | PowerShellコンソール/ISE | 主画面 | コマンド実行 |
| - | SSMS可用性グループプロパティ | 参照画面 | データベースメンバーシップ確認 |

## 機能種別

DELETE（削除）/ 可用性グループ管理

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | No | 対象SQL Serverインスタンス（SQL Server 2012以上） | インスタンス接続可能性検証 |
| SqlCredential | PSCredential | No | 代替認証資格情報 | 有効なPSCredentialオブジェクト |
| Database | string[] | No | 削除対象のデータベース名 | SqlInstance指定時は必須 |
| AvailabilityGroup | string[] | No | 対象可用性グループ名 | なし |
| InputObject | object[] | No | パイプライン入力用オブジェクト | AvailabilityDatabase/Database型 |
| EnableException | switch | No | 例外を有効化 | なし |
| WhatIf | switch | No | 実行シミュレーション | なし |
| Confirm | switch | No | 実行前確認 | なし |

### 入力データソース

- PowerShellパラメータ入力
- パイプラインからのオブジェクト（Get-DbaAgDatabase/Get-DbaDatabase出力）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | SQL Serverインスタンスのコンピュータ名 |
| InstanceName | string | SQL Serverインスタンス名 |
| SqlInstance | string | 完全なSQL Serverインスタンス名 |
| AvailabilityGroup | string | データベースが削除された可用性グループ名 |
| Database | string | 削除されたデータベース名 |
| Status | string | 操作結果（"Removed"） |

### 出力先

- PowerShellパイプライン（標準出力）
- オブジェクト型：PSCustomObject

## 処理フロー

### 処理シーケンス

```
1. パラメータ検証
   └─ SqlInstanceまたはInputObjectの必須チェック
2. Database検証（SqlInstance指定時）
   └─ Database必須チェック
3. InputObject型判定
   └─ Database型の場合はDatabase名を抽出
4. AGデータベース取得
   └─ Get-DbaAgDatabaseでAGデータベースオブジェクト取得
5. データベース削除
   └─ Drop()メソッドでAGから削除
6. 結果出力
   └─ PSCustomObjectでステータス出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{SqlInstance or InputObject?}
    B -->|Neither| C[Stop-Function: エラー]
    B -->|OK| D{SqlInstance指定?}
    D -->|Yes| E{Database指定?}
    E -->|No| F[Stop-Function: Database必須エラー]
    E -->|Yes| G[Get-DbaAgDatabase]
    D -->|No| H{InputObject型 = Database?}
    H -->|Yes| I[Database名を抽出]
    I --> G
    H -->|No| J[InputObject使用]
    G --> K[InputObjectにDB追加]
    J --> K
    K --> L[各DBをforeach]
    L --> M{ShouldProcess確認}
    M -->|Yes| N[Drop呼び出し]
    M -->|No| L
    N --> O[PSCustomObject出力]
    O --> L
    L -->|完了| P[終了]
    C --> P
    F --> P
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-01 | パラメータ排他 | SqlInstanceとInputObjectの少なくとも一方が必須 | 常時 |
| BR-02 | Database必須 | SqlInstance使用時はDatabase必須 | SqlInstance指定時 |
| BR-03 | 高影響確認 | ConfirmImpact = High（確認ダイアログ表示） | 常時 |
| BR-04 | ファイル保持 | 各レプリカ上のDBファイルは削除されない | 常時 |
| BR-05 | Database型対応 | InputObjectがDatabase型の場合は名前を抽出 | パイプライン入力時 |

### 計算ロジック

特になし（削除操作のため）

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| AGメンバーシップ削除 | sys.availability_databases_cluster | DELETE | AGデータベースメンバーシップ削除 |

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

本コマンドはSMOのDrop()メソッドを使用し、可用性グループからデータベースを削除します。データベースファイル自体は削除されません。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ConnectionError | インスタンス接続失敗 | 接続情報・ネットワーク確認 |
| - | ParameterValidation | 必須パラメータ未指定 | パラメータ指定を確認 |
| - | DropFailed | 削除操作失敗 | AG状態・権限確認 |

### リトライ仕様

リトライ機能なし。失敗時はStop-Function -Continueでエラー出力後継続。

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

SMOのDrop()メソッドによる暗黙的トランザクション管理。

## パフォーマンス要件

- 単一データベース削除：数秒以内

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

- ALTER AVAILABILITY GROUP権限またはsysadmin権限が必要
- Windows認証/SQL認証/AD認証対応
- SqlCredentialによる資格情報の安全な受け渡し
- ConfirmImpact = Highによる実行前確認

## 備考

- データベースファイルは各レプリカで保持されるため、再参加やスタンドアロン使用が可能
- プライマリレプリカから実行する必要がある

---

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

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

### 推奨読解順序

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

入力はAvailabilityDatabaseまたはDatabaseオブジェクト、出力はPSCustomObjectです。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Remove-DbaAgDatabase.ps1 | `public/Remove-DbaAgDatabase.ps1` | 出力PSCustomObject構造（121-128行目） |

**読解のコツ**: InputObjectはAvailabilityDatabaseとDatabase両方を受け入れるため、型判定ロジック（107-110行目）に注目してください。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Remove-DbaAgDatabase.ps1 | `public/Remove-DbaAgDatabase.ps1` | processブロック（93-134行目） |

**主要処理フロー**:
1. **94-97行目**: パラメータ検証（SqlInstanceまたはInputObjectの必須チェック）
2. **99-104行目**: SqlInstance時のDatabase必須チェック
3. **106-110行目**: InputObjectがDatabase型の場合の処理
4. **112-114行目**: Get-DbaAgDatabaseでAGデータベース取得
5. **116-133行目**: foreachでデータベース削除処理

#### Step 3: 依存コマンドを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Get-DbaAgDatabase.ps1 | `public/Get-DbaAgDatabase.ps1` | AGデータベース情報取得 |

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

```
Remove-DbaAgDatabase
    │
    ├─ Test-Bound (パラメータ検証)
    │
    ├─ [InputObject型判定]
    │      └─ Database型 → Database名抽出
    │
    ├─ Get-DbaAgDatabase (SqlInstance指定時)
    │      └─ Get-DbaAvailabilityGroup
    │
    ├─ ShouldProcess (確認ダイアログ)
    │
    └─ AvailabilityDatabases[name].Drop()
```

### データフロー図

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

SqlInstance ───▶ Get-DbaAgDatabase ────┐
                                       │
InputObject ───────────────────────────┼─▶ AGデータベースオブジェクト
     │                                 │
     ├─[Database型] → DB名抽出 ────────┤
     │                                 │
     └─[AGDatabase型] ─────────────────┘
                                       │
                                       ▼
                                Drop()呼び出し
                                       │
                                       ▼
                            PSCustomObject出力 ───▶ パイプライン
                            ├─ ComputerName
                            ├─ InstanceName
                            ├─ SqlInstance
                            ├─ AvailabilityGroup
                            ├─ Database
                            └─ Status: "Removed"
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Remove-DbaAgDatabase.ps1 | `public/Remove-DbaAgDatabase.ps1` | ソース | メインコマンド実装 |
| Get-DbaAgDatabase.ps1 | `public/Get-DbaAgDatabase.ps1` | ソース | AGデータベース取得 |
| Add-DbaAgDatabase.ps1 | `public/Add-DbaAgDatabase.ps1` | ソース | データベース追加コマンド（関連） |
| Get-DbaDatabase.ps1 | `public/Get-DbaDatabase.ps1` | ソース | データベース取得（パイプライン入力用） |
