# 機能設計書 438-Disable-DbaReplDistributor

## 概要

本ドキュメントは、dbatools PowerShellモジュールにおけるDisable-DbaReplDistributor機能の設計仕様を定義する。

### 本機能の処理概要

Disable-DbaReplDistributorは、SQL Serverインスタンスからレプリケーション配布構成を削除する機能である。

**業務上の目的・背景**：レプリケーション環境の解体、配布サーバーの移行、トラブルシューティングのための再構成など、ディストリビューターロールを解除する必要がある場面は多い。この機能は、配布データベースと配布構成を完全に削除し、インスタンスを非ディストリビューター状態に戻す。Forceパラメータにより、依存オブジェクトや到達不能なリモートパブリッシャーがある場合でも強制削除が可能。

**機能の利用シーン**：
- レプリケーション環境の完全解体
- 配布サーバーの移行に伴う旧サーバーのクリーンアップ
- レプリケーション問題のトラブルシューティング時の再構成
- 孤立したレプリケーション構成のクリーンアップ

**主要な処理内容**：
1. Get-DbaReplServerでレプリケーションサーバー情報取得
2. IsDistributorでディストリビューター状態確認
3. 配布データベースへの接続を終了
4. UninstallDistributorメソッドで配布構成削除
5. 削除後の状態を返却

**関連システム・外部連携**：SQL Server Replication、配布データベース

**権限による制御**：sysadmin権限が必要。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | 該当なし（コマンドライン機能） | - | - |

## 機能種別

データ操作 / DELETE処理 / 構成変更

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | Yes | 対象のSQL Serverインスタンス | パイプライン入力可能 |
| SqlCredential | PSCredential | No | 代替認証情報 | - |
| Force | switch | No | 依存オブジェクト存在時も強制削除 | - |
| WhatIf | switch | No | 実行前確認（実行しない） | - |
| Confirm | switch | No | 実行確認プロンプト | デフォルト有効（High Impact） |
| EnableException | switch | No | 例外処理の有効化 | - |

### 入力データソース

- SqlInstanceの直接指定（パイプライン可）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | SQL Serverインスタンスのコンピュータ名 |
| InstanceName | string | SQL Serverインスタンス名 |
| SqlInstance | string | 完全なSQL Serverインスタンス名 |
| IsDistributor | bool | ディストリビューター状態（削除後はFalse） |
| IsPublisher | bool | パブリッシャー状態 |
| DistributionServer | string | 配布サーバー名 |
| DistributionDatabase | string | 配布データベース名 |

### 出力先

- レプリケーションサーバーオブジェクトをパイプライン出力

## 処理フロー

### 処理シーケンス

```
1. レプリケーションサーバー取得
   └─ Get-DbaReplServerで接続・情報取得
2. ディストリビューター状態確認
   └─ IsDistributorプロパティで確認
3. 配布データベース接続終了
   └─ Get-DbaProcessで接続プロセス取得
   └─ Stop-DbaProcessで接続終了
4. ShouldProcess確認
   └─ ConfirmImpact = HighのためデフォルトでConfirm
5. ディストリビューターアンインストール
   └─ UninstallDistributorメソッド実行
6. 状態更新・結果返却
   └─ Refreshで状態更新、ReplicationServerオブジェクト返却
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[Get-DbaReplServer]
    B --> C{IsDistributor?}
    C -->|No| D[Stop-Function 非ディストリビューター]
    C -->|Yes| E[Get-DbaProcess 配布DB接続]
    E --> F[Stop-DbaProcess 接続終了]
    F --> G[ShouldProcess確認]
    G -->|No| H{次のインスタンス?}
    G -->|Yes| I[UninstallDistributor実行]
    I --> J{成功?}
    J -->|No| K[Stop-Function]
    J -->|Yes| L[Refresh状態更新]
    L --> M[ReplicationServer返却]
    M --> H
    D --> H
    K --> H
    H -->|Yes| B
    H -->|No| N[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | ディストリビューター確認 | 非ディストリビューターの場合はエラー | 常時 |
| BR-002 | 接続強制終了 | 配布データベースへの接続を事前に終了 | 常時 |
| BR-003 | Force強制削除 | 依存オブジェクト存在時もForceで強制削除可能 | Force指定時 |
| BR-004 | 確認プロンプト | ConfirmImpact = HighのためデフォルトでConfirm | 常時 |

### 計算ロジック

特になし。

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| 配布構成削除 | distribution.*  | DROP DATABASE | 配布データベース削除 |
| 構成削除 | msdb系 | DELETE | レプリケーション構成情報削除 |

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

RMO（Replication Management Objects）を介した間接的な操作のため、直接のテーブル操作仕様は非公開。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | 状態エラー | 非ディストリビューターインスタンス | ディストリビューター構成を確認 |
| - | 依存エラー | 依存オブジェクト存在（Force未指定） | Forceパラメータを指定 |
| - | 接続エラー | 配布DB接続終了失敗 | 手動で接続を終了 |

### リトライ仕様

リトライ機能は実装されていない。

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

トランザクション管理はRMOに委譲。

## パフォーマンス要件

特定のパフォーマンス要件は定義されていない。大規模配布データベースの削除には時間がかかる可能性。

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

- sysadmin権限が必要
- ConfirmImpact = Highにより誤操作を防止
- 配布データベースへの接続を強制終了するため、他のユーザーへの影響に注意

## 備考

- Forceパラメータはリモートパブリッシャーへの接続が不可能な場合にも有用
- 削除前に配布データベースへの全接続を自動終了

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Microsoft.SqlServer.Replication.ReplicationServer | (RMO) | IsDistributor、UninstallDistributorメソッド |

**読解のコツ**: ReplicationServerオブジェクトのIsDistributorプロパティで現在の状態を確認。UninstallDistributorはForce引数を取る。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Disable-DbaReplDistributor.ps1 | `public/Disable-DbaReplDistributor.ps1` | パラメータ定義、ConfirmImpact設定 |

**主要処理フロー**:
1. **87-94行目**: パラメータ定義
2. **96-98行目**: Get-DbaReplServerでレプリケーションサーバー取得

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

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

**主要処理フロー**:
- **102行目**: IsDistributor確認
- **104-108行目**: ShouldProcess、配布DB接続終了、UninstallDistributor
- **114-115行目**: Refresh、結果返却

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

```
Disable-DbaReplDistributor
    │
    ├─ Get-DbaReplServer
    │      └─ レプリケーションサーバー取得
    │
    ├─ Get-DbaProcess
    │      └─ 配布DB接続プロセス取得
    │
    ├─ Stop-DbaProcess
    │      └─ 接続プロセス終了
    │
    └─ [ReplicationServer].UninstallDistributor()
           └─ 配布構成削除
```

### データフロー図

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

SqlInstance ────────────▶ Get-DbaReplServer ─────────┐
                                                     │
                         IsDistributor確認 ──────────┤
                                                     │
Force ──────────────────▶ UninstallDistributor ──────┼──▶ ReplicationServer
                         (配布構成削除)              │    {IsDistributor: False}
                                                     │
                         Refresh ────────────────────┘
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Disable-DbaReplDistributor.ps1 | `public/Disable-DbaReplDistributor.ps1` | ソース | メイン機能実装 |
| Get-DbaReplServer.ps1 | `public/Get-DbaReplServer.ps1` | ソース | レプリケーションサーバー取得 |
| Get-DbaProcess.ps1 | `public/Get-DbaProcess.ps1` | ソース | プロセス取得 |
| Stop-DbaProcess.ps1 | `public/Stop-DbaProcess.ps1` | ソース | プロセス終了 |
