# 機能設計書 456-Remove-DbaReplSubscription

## 概要

本ドキュメントは、dbatools PowerShellモジュールにおける`Remove-DbaReplSubscription`関数の機能設計を定義する。この関数はSQL Serverレプリケーションのサブスクリプションを削除し、パブリッシャーとサブスクライバー間のレプリケーション接続を解除する。

### 本機能の処理概要

**業務上の目的・背景**：レプリケーション構成の変更時に、特定のサブスクライバーへのレプリケーションを停止する必要がある場合がある。本関数は、パブリケーションを維持したまま、個別のサブスクリプションのみを削除することを可能にする。これにより、サブスクライバーの入れ替えやレプリケーション構成の部分的な変更を効率的に行える。

**機能の利用シーン**：
- サブスクライバーサーバーの廃止時
- レプリケーション構成の変更時
- サブスクリプションの再作成が必要な場合
- CI/CD パイプラインでのテスト環境リセット時

**主要な処理内容**：
1. パブリケーション情報の取得
2. パブリケーションタイプ別のサブスクリプションオブジェクト作成
3. IsExistingObjectによる存在確認
4. サブスクリプションのRemove()メソッド呼び出し

**関連システム・外部連携**：SQL Server Replication Management Objects (RMO)

**権限による制御**：sysadminまたはdb_owner権限、およびパブリケーション管理者権限が必要

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| N/A | SQL Server Management Studio - レプリケーションモニター | 参照画面 | サブスクリプション削除操作に相当 |

## 機能種別

CRUD操作（Delete） / レプリケーション構成変更

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | Yes | パブリッシャーSQL Serverインスタンス | パイプライン入力対応 |
| SqlCredential | PSCredential | No | パブリッシャー接続用資格情報 | 有効な認証情報 |
| Database | String | Yes | パブリケーションデータベース名 | 存在するデータベース |
| PublicationName | String | Yes | パブリケーション名 | 存在するパブリケーション |
| SubscriberSqlInstance | DbaInstanceParameter | Yes | サブスクライバーSQL Serverインスタンス | 有効なインスタンス |
| SubscriberSqlCredential | PSCredential | No | サブスクライバー接続用資格情報 | 有効な認証情報 |
| SubscriptionDatabase | String | Yes | サブスクリプションデータベース名 | 存在するデータベース |
| EnableException | Switch | No | 例外を有効化 | なし |

### 入力データソース

- パラメータ入力のみ

## 出力仕様

### 出力データ

本関数は出力オブジェクトを返さない（None）。処理結果はWrite-MessageおよびWrite-Warningによるログ出力のみ。

### 出力先

パイプライン出力なし

## 処理フロー

### 処理シーケンス

```
1. パブリケーション情報取得
   └─ Get-DbaReplPublicationで対象パブリケーション取得
2. パブリケーション存在確認
   └─ 存在しない場合はWrite-Warningで警告
3. 各サブスクライバーに対する処理（foreach）
   ├─ ShouldProcess確認
   ├─ パブリケーションタイプ判定
   ├─ Transactional/Snapshot の場合
   │   ├─ TransSubscriptionオブジェクト作成
   │   ├─ プロパティ設定
   │   ├─ IsExistingObject確認
   │   └─ Remove()実行
   └─ Merge の場合
       ├─ MergeSubscriptionオブジェクト作成
       ├─ プロパティ設定
       ├─ IsExistingObject確認
       └─ Remove()実行（または警告）
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[Get-DbaReplPublication]
    B --> C{パブリケーション存在?}
    C -->|No| D[Write-Warning]
    C -->|Yes| E[foreach SubscriberSqlInstance]
    D --> E
    E --> F[ShouldProcess確認]
    F -->|No| G[スキップ]
    F -->|Yes| H{Type判定}
    H -->|Transactional/Snapshot| I[TransSubscription作成]
    H -->|Merge| J[MergeSubscription作成]
    I --> K[プロパティ設定]
    J --> L[プロパティ設定]
    K --> M{IsExistingObject?}
    L --> N{IsExistingObject?}
    M -->|Yes| O[Remove実行]
    M -->|No| P[警告なし]
    N -->|Yes| Q[Remove実行]
    N -->|No| R[Write-Warning]
    O --> S[次のサブスクライバー]
    P --> S
    Q --> S
    R --> S
    G --> S
    S --> E
    E -->|完了| T[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | Push サブスクリプション対応 | 現在はPushサブスクリプションのみ対応 | 常時適用 |
| BR-002 | ConfirmImpact High | 削除操作のため、確認プロンプトを表示 | -Confirmが有効な場合 |
| BR-003 | 存在確認後削除 | IsExistingObjectで存在確認後にRemove実行 | 常時適用 |

### 計算ロジック

特になし

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| サブスクリプション削除 | MSsubscriptions | DELETE | サブスクリプション情報の削除 |

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

#### MSsubscriptions (distribution database)

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| DELETE | subscription_id | 対象サブスクリプションID | サブスクリプション削除 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| N/A | パブリケーション不存在 | Get-DbaReplPublicationで取得失敗 | 正しいパブリケーション名を指定 |
| N/A | サブスクリプション不存在 | IsExistingObject = false | サブスクリプション情報を確認 |
| N/A | 削除失敗 | Remove()メソッドでエラー | 権限確認 |

### リトライ仕様

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

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

Remove()は個別トランザクションで実行。

## パフォーマンス要件

サブスクリプション削除は通常数秒で完了。

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

- パブリッシャーでsysadminまたはdb_owner権限が必要
- SqlCredentialはSecureStringとして処理
- ConfirmImpact = 'High'により、誤操作を防止

## 備考

- Pullサブスクリプションの削除は現在未実装（TODO: 118-119行目）
- サブスクリプション削除後、サブスクリプションデータベースのデータは残存
- 削除結果オブジェクトは出力されない（Get-DbaReplSubscriptionで確認が必要）

---

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

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

### 推奨読解順序

#### Step 1: 関数構造とパラメータを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Remove-DbaReplSubscription.ps1 | `public/Remove-DbaReplSubscription.ps1` | param()ブロック（85-100行目） |

**読解のコツ**: すべてのパラメータが必須（`[Parameter(Mandatory)]`）であることに注意。

#### Step 2: 初期化処理（beginブロック）を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Remove-DbaReplSubscription.ps1 | `public/Remove-DbaReplSubscription.ps1` | beginブロック（101-108行目） |

**主要処理フロー**:
1. **103行目**: Get-DbaReplPublicationでパブリケーション取得
2. **105-107行目**: パブリケーション未存在時のWrite-Warning

#### Step 3: サブスクリプション削除処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Remove-DbaReplSubscription.ps1 | `public/Remove-DbaReplSubscription.ps1` | processブロック（110-152行目） |

**主要処理フロー**:
- **111行目**: foreachでSubscriberSqlInstanceをループ
- **116-130行目**: Transactional/Snapshot処理
- **120-125行目**: TransSubscriptionオブジェクト設定
- **127-129行目**: IsExistingObject確認とRemove実行
- **132-146行目**: Merge処理

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

```
Remove-DbaReplSubscription
    │
    ├─ [begin] Get-DbaReplPublication
    │      └─ パブリケーション情報取得
    │
    └─ [process] foreach (SubscriberSqlInstance)
           │
           ├─ [RMO] TransSubscription
           │      ├─ ConnectionContext設定
           │      ├─ DatabaseName設定
           │      ├─ PublicationName設定
           │      ├─ SubscriptionDBName設定
           │      ├─ SubscriberName設定
           │      ├─ IsExistingObject確認
           │      └─ Remove()
           │
           └─ [RMO] MergeSubscription
                  ├─ ConnectionContext設定
                  ├─ 各プロパティ設定
                  ├─ IsExistingObject確認
                  └─ Remove()
```

### データフロー図

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

SqlInstance ─────────────────▶ Get-DbaReplPublication ───────────────▶ パブリケーション情報
PublicationName ────────────────────────┘
                                   │
Database ────────────────────▶ TransSubscription/MergeSubscription
SubscriberSqlInstance ───────▶ オブジェクト設定 ─────────────────────▶ サブスクリプション特定
SubscriptionDatabase ────────────────────┘
                                   │
                             IsExistingObject確認 ────────────────────▶ 存在確認
                                   │
                             Remove() ────────────────────────────────▶ (出力なし)
                                                                        Write-Message/Warning
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Remove-DbaReplSubscription.ps1 | `public/Remove-DbaReplSubscription.ps1` | ソース | メイン関数定義 |
| Get-DbaReplPublication.ps1 | `public/Get-DbaReplPublication.ps1` | ソース | パブリケーション情報取得 |
| New-DbaReplSubscription.ps1 | `public/New-DbaReplSubscription.ps1` | ソース | 対となるサブスクリプション作成機能 |
| Get-DbaReplSubscription.ps1 | `public/Get-DbaReplSubscription.ps1` | ソース | サブスクリプション情報取得 |
