# 機能設計書 445-Get-DbaReplDistributor

## 概要

本ドキュメントは、SQL Serverインスタンスからレプリケーションディストリビューター構成およびステータス情報を取得するdbatools PowerShellコマンドレット `Get-DbaReplDistributor` の機能設計を記述する。

### 本機能の処理概要

Get-DbaReplDistributorは、SQL Serverインスタンスのレプリケーションディストリビューター構成と状態に関する詳細情報を取得するコマンドレットである。

**業務上の目的・背景**：レプリケーショントポロジーを管理する際、どのサーバーがディストリビューターとして機能しているか、配布データベースの場所、リモートパブリッシャーの有無などを把握することが重要である。この機能により、データベース管理者はレプリケーション環境の構成を素早く確認し、トラブルシューティングや構成監査を効率的に行える。

**機能の利用シーン**：
- レプリケーショントポロジーの構成確認時に、各サーバーの役割を特定する場面
- ディストリビューターの可用性を監視する場面
- レプリケーション環境の文書化や監査を行う場面
- 新しいパブリッシャーを追加する前にディストリビューター構成を確認する場面

**主要な処理内容**：
1. 各SqlInstanceに対してGet-DbaReplServerを呼び出しReplicationServerオブジェクトを取得
2. 取得したオブジェクトのディストリビューター関連プロパティを抽出
3. Select-DefaultViewで既定のプロパティを選択して出力

**関連システム・外部連携**：
- Get-DbaReplServerに依存してReplicationServerオブジェクトを取得
- SQL Server Replication Management Objects (RMO) を使用

**権限による制御**：
- SQL Serverインスタンスへのアクセス権限が必要
- レプリケーション構成情報の読み取り権限が必要

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | CLIコマンド | 主画面 | PowerShellコマンドラインから直接実行 |

## 機能種別

データ取得 / 情報参照

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | Yes | ディストリビューター情報を取得するSQL Serverインスタンス | 有効なSQL Serverインスタンス名 |
| SqlCredential | PSCredential | No | 代替認証情報 | Get-Credentialで取得した有効な認証情報 |
| EnableException | switch | No | 例外処理を有効化 | - |

### 入力データソース

PowerShellコマンドライン引数、パイプライン入力（SqlInstanceパラメータ）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | SQL Serverインスタンスをホストするコンピュータ名 |
| InstanceName | string | SQL Serverインスタンス名 |
| SqlInstance | string | 完全なSQL Serverインスタンス名 |
| IsPublisher | bool | パブリッシャーとして構成されているかどうか |
| IsDistributor | bool | ディストリビューターとして構成されているかどうか |
| DistributionServer | string | 配布データベースをホストするサーバー名（ディストリビューターでない場合はnull） |
| DistributionDatabase | string | 配布データベース名（ディストリビューターでない場合はnull） |
| DistributorInstalled | bool | ディストリビューターコンポーネントがインストールされているかどうか |
| DistributorAvailable | bool | ディストリビューターが現在利用可能で機能しているかどうか |
| HasRemotePublisher | bool | リモートパブリッシャーが構成されているかどうか |

### 出力先

PowerShellパイプライン（Microsoft.SqlServer.Replication.ReplicationServerオブジェクト）

## 処理フロー

### 処理シーケンス

```
1. processブロック
   └─ Test-FunctionInterruptで中断チェック
   └─ 各SqlInstanceに対してループ
       └─ Get-DbaReplServerを呼び出してReplicationServerオブジェクト取得
       └─ エラー発生時はStop-Functionで処理停止
       └─ Select-DefaultViewで10プロパティを選択して出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{Test-FunctionInterrupt?}
    B -->|Yes| C[終了]
    B -->|No| D[SqlInstanceループ]
    D --> E[Get-DbaReplServer]
    E --> F{取得成功?}
    F -->|No| G[Stop-Function]
    F -->|Yes| H[Select-DefaultView]
    H --> I{次のInstance?}
    G --> I
    I -->|Yes| D
    I -->|No| C
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | Get-DbaReplServer委譲 | ディストリビューター情報はGet-DbaReplServerから取得 | 常時 |
| BR-002 | 10プロパティ出力 | 10個の既定プロパティをSelect-DefaultViewで出力 | 常時 |

### 計算ロジック

特になし（プロパティの選択のみ）

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| ディストリビューター情報取得 | レプリケーションシステムテーブル | SELECT | RMO経由で読み取り専用アクセス |

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

本機能は読み取り専用操作のため、データベースへの書き込みは行わない。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ConnectionError | SQL Serverインスタンスへの接続失敗 | 接続情報を確認し再試行 |
| - | ProcessError | ディストリビューター情報取得失敗 | インスタンスの状態を確認 |

### リトライ仕様

自動リトライは行わない。Stop-Functionで処理を停止し、-Continueで次のインスタンスの処理を継続する。

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

読み取り専用操作のため、トランザクション管理は不要。

## パフォーマンス要件

インスタンス数に依存するが、1インスタンスあたり1秒以内に完了する。

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

- 認証情報はPSCredentialとして安全に処理される
- レプリケーション構成情報の読み取りには適切な権限が必要

## 備考

- ReplicationDatabases, DistributionDatabaseAvailable, HardwareBoundary, PublisherListなどの追加プロパティはSelect-Object *で取得可能
- ディストリビューターとして構成されていないインスタンスでもエラーにならず、IsDistributor=falseとして返される

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Get-DbaReplServer.ps1 | `public/Get-DbaReplServer.ps1` | ReplicationServerオブジェクトの構造 |

**読解のコツ**: ReplicationServerオブジェクトのプロパティがそのままディストリビューター情報として使用される。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Get-DbaReplDistributor.ps1 | `public/Get-DbaReplDistributor.ps1` | メインのコマンドレット実装 |

**主要処理フロー**:
1. **78-79行目**: processブロック開始、中断チェック
2. **80-81行目**: SqlInstanceループ開始、Verboseメッセージ出力
3. **84-85行目**: Get-DbaReplServerを呼び出し
4. **91行目**: Select-DefaultViewで出力

#### Step 3: 依存関数を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Get-DbaReplServer.ps1 | `public/Get-DbaReplServer.ps1` | ReplicationServerオブジェクト取得 |

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

```
Get-DbaReplDistributor
    │
    └─ Get-DbaReplServer
           ├─ Add-ReplicationLibrary
           ├─ Connect-DbaInstance
           └─ New-Object Microsoft.SqlServer.Replication.ReplicationServer
```

### データフロー図

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

SqlInstance ──────────────────▶ Get-DbaReplServer ────────────────────▶ ReplicationServer
                                      │
SqlCredential ────────────────▶ 認証処理
                                      │
                               Select-DefaultView
                                      │
                                      ▼
                               10プロパティのオブジェクト
                               (IsDistributor, DistributionServer等)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Get-DbaReplDistributor.ps1 | `public/Get-DbaReplDistributor.ps1` | ソース | メインコマンドレット実装 |
| Get-DbaReplServer.ps1 | `public/Get-DbaReplServer.ps1` | ソース | ReplicationServerオブジェクト取得 |
| Add-ReplicationLibrary.ps1 | `private/functions/Add-ReplicationLibrary.ps1` | ソース | レプリケーションライブラリのロード |
| Get-DbaReplDistributor.Tests.ps1 | `tests/Get-DbaReplDistributor.Tests.ps1` | テスト | ユニットテスト |
