# 機能設計書 20-Remove-DbaAgReplica

## 概要

本ドキュメントは、SQL Server可用性グループからセカンダリレプリカを削除するRemove-DbaAgReplicaコマンドの機能設計書です。

### 本機能の処理概要

Remove-DbaAgReplicaは、レプリカオブジェクトのDrop()メソッドを呼び出して可用性グループからセカンダリレプリカを削除するPowerShellコマンドレットです。サーバーのデコミッショニング、AGトポロジーのスケールダウン、または復旧できない障害レプリカの削除時に使用されます。

**業務上の目的・背景**：可用性グループのトポロジーを変更する際、不要になったセカンダリレプリカや、障害から復旧できないレプリカを削除する必要があります。このコマンドは、SSMSを使用せずにPowerShellからレプリカを安全に削除することを可能にし、自動化スクリプトやメンテナンス操作での使用に適しています。すべての削除操作は、高影響な変更であるため明示的な確認が必要です。

**機能の利用シーン**：
- サーバーのデコミッショニング
- AGトポロジーのスケールダウン
- 障害レプリカの削除
- データセンター移行時の古いレプリカ削除
- テスト環境のクリーンアップ

**主要な処理内容**：
1. 指定されたSQL Serverインスタンスに接続
2. 対象レプリカを取得（Get-DbaAgReplica使用）
3. レプリカを削除（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オブジェクト |
| AvailabilityGroup | string[] | No | 対象可用性グループ名（ワイルドカード対応） | なし |
| Replica | string[] | No | 削除対象のレプリカ名（ワイルドカード対応） | SqlInstance指定時は必須 |
| InputObject | AvailabilityReplica[] | No | パイプライン入力用レプリカオブジェクト | Microsoft.SqlServer.Management.Smo.AvailabilityReplica型 |
| EnableException | switch | No | 例外を有効化 | なし |
| WhatIf | switch | No | 実行シミュレーション | なし |
| Confirm | switch | No | 実行前確認 | なし |

### 入力データソース

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

## 出力仕様

### 出力データ

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

### 出力先

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

## 処理フロー

### 処理シーケンス

```
1. パラメータ検証
   └─ SqlInstanceまたはInputObjectの必須チェック
2. Replica検証（SqlInstance指定時）
   └─ Replica必須チェック
3. レプリカ取得
   └─ Get-DbaAgReplicaでレプリカオブジェクト取得
4. レプリカ削除
   └─ Drop()メソッドでAGから削除
5. 結果出力
   └─ PSCustomObjectでステータス出力
```

### フローチャート

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

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-01 | パラメータ排他 | SqlInstanceとInputObjectの少なくとも一方が必須 | 常時 |
| BR-02 | Replica必須 | SqlInstance使用時はReplica必須 | SqlInstance指定時 |
| BR-03 | 高影響確認 | ConfirmImpact = High（確認ダイアログ表示） | 常時 |
| BR-04 | セカンダリのみ | プライマリレプリカは削除不可（AGの削除が必要） | 常時 |

### 計算ロジック

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

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| レプリカ削除 | sys.availability_replicas | DELETE | AGレプリカレコード削除 |

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

本コマンドはSMOのDrop()メソッドを使用し、可用性グループからレプリカを削除します。WSFCリソースも同時に更新されます。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ConnectionError | インスタンス接続失敗 | 接続情報・ネットワーク確認 |
| - | ParameterValidation | 必須パラメータ未指定 | パラメータ指定を確認 |
| - | DropFailed | 削除操作失敗 | AG状態・権限確認 |
| - | PrimaryReplica | プライマリレプリカを削除しようとした | AGを削除するか別のレプリカを指定 |

### リトライ仕様

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

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

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

## パフォーマンス要件

- 単一レプリカ削除：数秒以内

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

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

## 備考

- プライマリレプリカからの実行が必要
- 削除されたレプリカのSQL Serverインスタンスは引き続き稼働するが、AGメンバーではなくなる
- 再参加するにはAdd-DbaAgReplicaを使用

---

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

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

### 推奨読解順序

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

入力はAvailabilityReplicaオブジェクト、出力はPSCustomObjectです。

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

**読解のコツ**: AvailabilityGroupプロパティはagreplica.Parent.AvailabilityGroupから取得されています（109行目）。

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

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

**主要処理フロー**:
1. **87-90行目**: パラメータ検証（SqlInstanceまたはInputObjectの必須チェック）
2. **92-95行目**: SqlInstance時のReplica必須チェック
3. **97-99行目**: Get-DbaAgReplicaでレプリカ取得
4. **101-117行目**: foreachでレプリカ削除処理

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Get-DbaAgReplica.ps1 | `public/Get-DbaAgReplica.ps1` | レプリカ情報取得 |

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

```
Remove-DbaAgReplica
    │
    ├─ Test-Bound (パラメータ検証)
    │
    ├─ Get-DbaAgReplica (SqlInstance指定時)
    │      └─ Get-DbaAvailabilityGroup
    │
    ├─ ShouldProcess (確認ダイアログ)
    │
    └─ agreplica.Drop()
```

### データフロー図

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

SqlInstance ───▶ Get-DbaAgReplica ─────┐
                                       │
InputObject ───────────────────────────┼─▶ Replicaオブジェクト
                                       │
Replica (filter) ──────────────────────┤
                                       │
AvailabilityGroup (filter) ────────────┘
                                       │
                                       ▼
                                Drop()呼び出し
                                       │
                                       ▼
                            PSCustomObject出力 ───▶ パイプライン
                            ├─ ComputerName
                            ├─ InstanceName
                            ├─ SqlInstance
                            ├─ AvailabilityGroup
                            ├─ Replica
                            └─ Status: "Removed"
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Remove-DbaAgReplica.ps1 | `public/Remove-DbaAgReplica.ps1` | ソース | メインコマンド実装 |
| Get-DbaAgReplica.ps1 | `public/Get-DbaAgReplica.ps1` | ソース | レプリカ取得 |
| Add-DbaAgReplica.ps1 | `public/Add-DbaAgReplica.ps1` | ソース | レプリカ追加コマンド（関連） |
| Set-DbaAgReplica.ps1 | `public/Set-DbaAgReplica.ps1` | ソース | レプリカ設定変更コマンド（関連） |
| Join-DbaAvailabilityGroup.ps1 | `public/Join-DbaAvailabilityGroup.ps1` | ソース | AG参加コマンド（関連） |
