# 機能設計書 440-Enable-DbaReplDistributor

## 概要

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

### 本機能の処理概要

Enable-DbaReplDistributorは、SQL Serverインスタンスをレプリケーションディストリビューターとして構成し、配布データベースを作成する機能である。

**業務上の目的・背景**：SQL Serverレプリケーションを設定する最初のステップとして、ディストリビューターの構成が必要である。この機能は、配布データベースの作成とディストリビューターロールのインストールを自動化し、レプリケーション環境の構築を効率化する。一度構成されると、インスタンスはレプリケーションメタデータの管理、パブリケーション/サブスクリプション情報の追跡、トランザクション/スナップショットレプリケーションのデータ移動の調整を行う。

**機能の利用シーン**：
- 新規レプリケーション環境の構築
- 配布サーバーの追加・移行
- レプリケーションインフラストラクチャの自動デプロイメント
- 開発/テスト環境のレプリケーション構成

**主要な処理内容**：
1. Get-DbaReplServerでレプリケーションサーバー情報取得
2. DistributionDatabaseオブジェクト作成
3. InstallDistributorメソッドでディストリビューター構成
4. 構成後の状態を返却

**関連システム・外部連携**：SQL Server Replication

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

## 関連画面

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

## 機能種別

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

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | Yes | 対象のSQL Serverインスタンス | パイプライン入力可能 |
| SqlCredential | PSCredential | No | 代替認証情報 | - |
| DistributionDatabase | string | No | 配布データベース名 | デフォルトは'distribution' |
| WhatIf | switch | No | 実行前確認（実行しない） | - |
| Confirm | switch | No | 実行確認プロンプト | - |
| EnableException | switch | No | 例外処理の有効化 | - |

### 入力データソース

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

## 出力仕様

### 出力データ

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

### 出力先

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

## 処理フロー

### 処理シーケンス

```
1. レプリケーションサーバー取得
   └─ Get-DbaReplServerで接続・情報取得
2. 配布データベースオブジェクト作成
   └─ DistributionDatabaseオブジェクトをNew-Objectで作成
3. プロパティ設定
   └─ ConnectionContext、Nameプロパティを設定
4. ShouldProcess確認
   └─ 実行確認
5. ディストリビューターインストール
   └─ InstallDistributorメソッド実行
6. 状態更新・結果返却
   └─ Refreshで状態更新、ReplicationServerオブジェクト返却
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[Get-DbaReplServer]
    B --> C[New-Object DistributionDatabase]
    C --> D[ConnectionContext設定]
    D --> E[Name設定]
    E --> F[ShouldProcess確認]
    F -->|No| G{次のインスタンス?}
    F -->|Yes| H[InstallDistributor実行]
    H --> I{成功?}
    I -->|No| J[Stop-Function]
    I -->|Yes| K[Refresh状態更新]
    K --> L[ReplicationServer返却]
    L --> G
    J --> G
    G -->|Yes| B
    G -->|No| M[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | デフォルトDB名 | DistributionDatabase未指定時は'distribution'を使用 | DistributionDatabase未指定時 |
| BR-002 | パスワードなし | InstallDistributorの第一引数はnull（パスワードなし） | 常時 |
| BR-003 | TODO追加プロパティ | 将来的に追加プロパティのサポートが予定 | - |

### 計算ロジック

特になし。

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| 配布DB作成 | - | CREATE DATABASE | 配布データベース作成 |
| 構成登録 | msdb系 | INSERT | ディストリビューター構成情報登録 |

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | インストールエラー | InstallDistributor実行失敗 | 権限、既存構成を確認 |
| - | 重複エラー | 既にディストリビューターが構成済み | 既存構成を削除するか別名を使用 |

### リトライ仕様

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

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

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

## パフォーマンス要件

特定のパフォーマンス要件は定義されていない。配布データベース作成にはディスクI/Oが発生。

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

- sysadmin権限が必要
- InstallDistributorはパスワードなし（null）で呼び出される

## 備考

- ソースコード内のTODOコメントにより、将来的に追加パラメータがサポートされる可能性
- レプリケーション設定の最初のステップとして実行

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Microsoft.SqlServer.Replication.ReplicationServer | (RMO) | InstallDistributorメソッド |
| 1-2 | Microsoft.SqlServer.Replication.DistributionDatabase | (RMO) | 配布データベースクラス |

**読解のコツ**: InstallDistributorメソッドは2つの引数（パスワード、DistributionDatabaseオブジェクト）を取る。パスワードはnullで呼び出される。

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

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

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

#### Step 3: 構成処理を理解する

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

**主要処理フロー**:
- **97-101行目**: DistributionDatabaseオブジェクト作成
- **103行目**: TODOコメント（将来拡張予定）
- **104行目**: InstallDistributor実行
- **106-107行目**: Refresh、結果返却

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

```
Enable-DbaReplDistributor
    │
    ├─ Get-DbaReplServer
    │      └─ レプリケーションサーバー取得
    │
    ├─ New-Object DistributionDatabase
    │      └─ 配布データベースオブジェクト作成
    │
    └─ [ReplicationServer].InstallDistributor()
           └─ ディストリビューター構成
```

### データフロー図

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

SqlInstance ────────────▶ Get-DbaReplServer ─────────┐
                                                     │
DistributionDatabase ───▶ New-Object ────────────────┤
                         DistributionDatabase        │
                                                     │
                         InstallDistributor ─────────┼──▶ ReplicationServer
                         (ディストリビューター構成)   │    {IsDistributor: True}
                                                     │
                         Refresh ────────────────────┘
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Enable-DbaReplDistributor.ps1 | `public/Enable-DbaReplDistributor.ps1` | ソース | メイン機能実装 |
| Get-DbaReplServer.ps1 | `public/Get-DbaReplServer.ps1` | ソース | レプリケーションサーバー取得 |
| Enable-DbaReplPublishing.ps1 | `public/Enable-DbaReplPublishing.ps1` | ソース | 関連機能（パブリッシャー有効化） |
