# 機能設計書 447-Get-DbaReplPublisher

## 概要

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

### 本機能の処理概要

Get-DbaReplPublisherは、ディストリビューターとして機能するSQL Serverインスタンスに構成されているパブリッシャーの詳細情報を取得するコマンドレットである。

**業務上の目的・背景**：レプリケーション環境において、ディストリビューターに登録されているパブリッシャーの状態、作業ディレクトリ、配布データベース、パブリケーション数などを把握することは、トポロジー管理とトラブルシューティングに重要である。この機能により、データベース管理者はパブリッシャーの健全性を監視し、構成の監査を行える。

**機能の利用シーン**：
- ディストリビューターに登録されているすべてのパブリッシャーを確認する場面
- パブリッシャーの状態（Healthy, Unhealthy）を監視する場面
- レプリケーショントポロジーのドキュメント化
- パブリッシャー接続問題のトラブルシューティング

**主要な処理内容**：
1. Connect-DbaInstanceで各SQL Serverインスタンスに接続
2. Get-DbaReplServerを呼び出しReplicationServerオブジェクトを取得
3. DistributionPublishersプロパティからパブリッシャー一覧を取得
4. 各パブリッシャーにメタデータ（ComputerName, InstanceName, SqlInstance）を追加
5. 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インスタンス名 |
| Status | string | パブリッシャーの現在のステータス（例：Healthy, Unhealthy） |
| WorkingDirectory | string | パブリケーションデータとスキーマファイルが保存されるディレクトリパス |
| DistributionDatabase | string | このパブリッシャーに使用される配布データベース名 |
| DistributionPublications | int | パブリッシャーのトランザクションパブリケーション数 |
| PublisherType | string | パブリッシャーのタイプ（MSSQLSERVER、またはサードパーティ識別子） |
| Name | string | パブリッシャーのインスタンス名 |

### 出力先

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

## 処理フロー

### 処理シーケンス

```
1. processブロック
   └─ 各SqlInstanceに対してループ
       └─ Connect-DbaInstanceで接続
       └─ Get-DbaReplServerを呼び出してReplicationServerオブジェクト取得
       └─ エラー発生時はStop-Functionで処理停止
       └─ DistributionPublishersプロパティからパブリッシャー取得
       └─ パブリッシャーが存在する場合のみメタデータ追加
       └─ Select-DefaultViewで9プロパティを選択して出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[SqlInstanceループ]
    B --> C[Connect-DbaInstance]
    C --> D{接続成功?}
    D -->|No| E[Stop-Function]
    D -->|Yes| F[Get-DbaReplServer]
    F --> G{取得成功?}
    G -->|No| H[Stop-Function]
    G -->|Yes| I[DistributionPublishers取得]
    I --> J{publisher存在?}
    J -->|No| K[出力なし]
    J -->|Yes| L[メタデータ追加]
    L --> M[Select-DefaultView]
    M --> N{次のInstance?}
    E --> N
    H --> N
    K --> N
    N -->|Yes| B
    N -->|No| O[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | ディストリビューター必須 | 対象インスタンスはディストリビューターとして構成されている必要がある | 常時 |
| BR-002 | パブリッシャー存在時のみ出力 | $publisherがnullまたは空の場合は出力なし | 常時 |
| BR-003 | 9プロパティ出力 | 9個の既定プロパティをSelect-DefaultViewで出力 | 常時 |

### 計算ロジック

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

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| パブリッシャー情報取得 | distribution.dbo.MSdistpublishers | SELECT | RMO経由で読み取り専用アクセス |

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

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

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

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

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

## パフォーマンス要件

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

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

- 認証情報はPSCredentialとして安全に処理される
- ディストリビューター構成情報の読み取りには適切な権限が必要

## 備考

- PublisherSecurity, RegisteredSubscribers, TransPublications, ThirdPartyなどの追加プロパティはSelect-Object *で取得可能
- ディストリビューターとして構成されていないインスタンスでは出力なし

---

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

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

### 推奨読解順序

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

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

**読解のコツ**: DistributionPublishersプロパティがパブリッシャー一覧を保持する。

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

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

**主要処理フロー**:
1. **81行目**: SqlInstanceループ開始
2. **83行目**: Connect-DbaInstanceで接続
3. **84行目**: Get-DbaReplServerを呼び出し
4. **91行目**: DistributionPublishersを取得
5. **97-100行目**: パブリッシャー存在時にメタデータ追加
6. **103行目**: Select-DefaultViewで出力

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

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

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

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

### データフロー図

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

SqlInstance ──────────────────▶ Connect-DbaInstance ──────────────────▶ Server
                                      │
SqlCredential ────────────────▶ 認証処理
                                      │
                               Get-DbaReplServer
                                      │
                               DistributionPublishers取得
                                      │
                               メタデータ追加（存在時のみ）
                                      │
                               Select-DefaultView
                                      │
                                      ▼
                               DistributionPublisherオブジェクト（9プロパティ）
```

### 関連ファイル一覧

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