# 機能設計書 439-Disable-DbaReplPublishing

## 概要

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

### 本機能の処理概要

Disable-DbaReplPublishingは、SQL Serverインスタンスのレプリケーションパブリッシング構成を無効化し、パブリッシャーロールを削除する機能である。

**業務上の目的・背景**：レプリケーション環境の解体、パブリッシャーの移行、構成問題のトラブルシューティングなど、パブリッシャーロールを解除する必要がある場面は多い。この機能は、ディストリビューターからパブリッシャー構成を削除し、インスタンスを非パブリッシャー状態に戻す。Forceパラメータにより、ディストリビューターへの接続が不可能な場合でも強制削除が可能。

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

**主要な処理内容**：
1. Get-DbaReplServerでレプリケーションサーバー情報取得
2. IsPublisherでパブリッシャー状態確認
3. DistributionPublishers.Removeでパブリッシャー構成削除
4. 削除後の状態を返却

**関連システム・外部連携**：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 | ディストリビューター状態 |
| IsPublisher | bool | パブリッシャー状態（削除後はFalse） |
| DistributionServer | string | 配布サーバー名 |
| DistributionDatabase | string | 配布データベース名 |

### 出力先

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

## 処理フロー

### 処理シーケンス

```
1. レプリケーションサーバー取得
   └─ Get-DbaReplServerで接続・情報取得
2. パブリッシャー状態確認
   └─ IsPublisherプロパティで確認
3. ShouldProcess確認
   └─ ConfirmImpact = HighのためデフォルトでConfirm
4. パブリッシャー構成削除
   └─ DistributionPublishers.Removeメソッド実行
5. 状態更新・結果返却
   └─ Refreshで状態更新、ReplicationServerオブジェクト返却
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[Get-DbaReplServer]
    B --> C{IsPublisher?}
    C -->|No| D[Stop-Function 非パブリッシャー]
    C -->|Yes| E[ShouldProcess確認]
    E -->|No| F{次のインスタンス?}
    E -->|Yes| G[DistributionPublishers.Remove実行]
    G --> H{成功?}
    H -->|No| I[Stop-Function]
    H -->|Yes| J[Refresh状態更新]
    J --> K[ReplicationServer返却]
    K --> F
    D --> F
    I --> F
    F -->|Yes| B
    F -->|No| L[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | パブリッシャー確認 | 非パブリッシャーの場合はエラー | 常時 |
| BR-002 | Force強制削除 | ディストリビューター接続不可時もForceで強制削除可能 | Force指定時 |
| BR-003 | 確認プロンプト | ConfirmImpact = HighのためデフォルトでConfirm | 常時 |

### 計算ロジック

特になし。

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| パブリッシャー削除 | distribution系 | DELETE | パブリッシャー構成情報削除 |

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | 状態エラー | 非パブリッシャーインスタンス | パブリッシャー構成を確認 |
| - | 接続エラー | ディストリビューター接続不可（Force未指定） | Forceパラメータを指定 |
| - | 削除エラー | Remove実行失敗 | 権限、構成を確認 |

### リトライ仕様

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

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

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

## パフォーマンス要件

特定のパフォーマンス要件は定義されていない。

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

- sysadmin権限が必要
- ConfirmImpact = Highにより誤操作を防止

## 備考

- ディストリビューターがリモートで到達不能な場合はForceパラメータが必要
- パブリッシャーに関連するレプリケーションオブジェクトも削除される

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Microsoft.SqlServer.Replication.ReplicationServer | (RMO) | IsPublisher、DistributionPublishersプロパティ |

**読解のコツ**: ReplicationServerオブジェクトのIsPublisherプロパティで現在の状態を確認。DistributionPublishersコレクションのRemoveメソッドでパブリッシャーを削除。

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

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

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

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

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

**主要処理フロー**:
- **97行目**: IsPublisher確認
- **99-101行目**: ShouldProcess、DistributionPublishers.Remove
- **103-104行目**: Refresh、結果返却

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

```
Disable-DbaReplPublishing
    │
    ├─ Get-DbaReplServer
    │      └─ レプリケーションサーバー取得
    │
    └─ [ReplicationServer].DistributionPublishers.Remove()
           └─ パブリッシャー構成削除
```

### データフロー図

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

SqlInstance ────────────▶ Get-DbaReplServer ─────────┐
                                                     │
                         IsPublisher確認 ────────────┤
                                                     │
Force ──────────────────▶ DistributionPublishers ────┼──▶ ReplicationServer
                         .Remove($Force)             │    {IsPublisher: False}
                         (パブリッシャー削除)         │
                                                     │
                         Refresh ────────────────────┘
```

### 関連ファイル一覧

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