# 機能設計書 448-Get-DbaReplServer

## 概要

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

### 本機能の処理概要

Get-DbaReplServerは、SQL Serverインスタンスがレプリケーショントポロジーにおいてディストリビューター、パブリッシャー、またはその両方として構成されているかを示すReplicationServerオブジェクトを取得するコマンドレットである。

**業務上の目的・背景**：レプリケーション環境において、各サーバーの役割と配布データベース構成を素早く把握することは、トラブルシューティングや環境のドキュメント化に不可欠である。この機能は他のレプリケーション関連コマンドレットの基盤として使用され、レプリケーション構成の基本情報を提供する。

**機能の利用シーン**：
- レプリケーショントポロジーにおける各サーバーの役割を確認する場面
- ディストリビューターが正しく構成されているかを検証する場面
- レプリケーション環境のドキュメント化
- 他のレプリケーションコマンドレットの内部で基本情報を取得する場面

**主要な処理内容**：
1. Add-ReplicationLibraryでレプリケーションライブラリをロード
2. Connect-DbaInstanceで各SQL Serverインスタンスに接続
3. Microsoft.SqlServer.Replication.ReplicationServerオブジェクトを作成
4. ConnectionContextを設定
5. メタデータ（ComputerName, InstanceName, SqlInstance）を追加
6. Select-DefaultViewで既定のプロパティを選択して出力

**関連システム・外部連携**：
- SQL Server Replication Management Objects (RMO) を使用
- Microsoft.SqlServer.Replication.dll と Microsoft.SqlServer.Rmo.dll に依存

**権限による制御**：
- 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インスタンス名 |
| IsDistributor | bool | ディストリビューターとして構成されているかどうか |
| IsPublisher | bool | パブリッシャーとして構成されているかどうか |
| DistributionServer | string | ディストリビューターサーバー名（構成されている場合） |
| DistributionDatabase | string | 配布データベース名（構成されている場合） |

### 出力先

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

## 処理フロー

### 処理シーケンス

```
1. beginブロック
   └─ Add-ReplicationLibraryでライブラリをロード
2. processブロック
   └─ Test-FunctionInterruptで中断チェック
   └─ 各SqlInstanceに対してループ
       └─ Connect-DbaInstanceで接続
       └─ New-Object Microsoft.SqlServer.Replication.ReplicationServerを作成
       └─ ConnectionContextを設定
       └─ メタデータを追加（ComputerName, InstanceName, SqlInstance）
       └─ Select-DefaultViewで7プロパティを選択して出力
       └─ エラー発生時はStop-Functionで処理停止
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[Add-ReplicationLibrary]
    B --> C{Test-FunctionInterrupt?}
    C -->|Yes| D[終了]
    C -->|No| E[SqlInstanceループ]
    E --> F[Connect-DbaInstance]
    F --> G[ReplicationServer作成]
    G --> H[ConnectionContext設定]
    H --> I[メタデータ追加]
    I --> J[Select-DefaultView]
    J --> K{エラー?}
    K -->|Yes| L[Stop-Function]
    K -->|No| M{次のInstance?}
    L --> M
    M -->|Yes| E
    M -->|No| D
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | RMO直接使用 | ReplicationServerオブジェクトをNew-Objectで直接作成 | 常時 |
| BR-002 | 7プロパティ出力 | 7個の既定プロパティをSelect-DefaultViewで出力 | 常時 |
| BR-003 | 基盤コマンド | 他のレプリケーションコマンドから呼び出される | 内部使用時 |

### 計算ロジック

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

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

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

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

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ConnectionError | SQL Serverインスタンスへの接続失敗 | 接続情報を確認し再試行 |
| - | RMOError | ReplicationServerオブジェクト作成失敗 | レプリケーションライブラリのインストールを確認 |

### リトライ仕様

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

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

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

## パフォーマンス要件

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

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

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

## 備考

- ReplicationDatabasesプロパティはレプリケーションが有効なデータベースを取得するが、実際にレプリケートされているとは限らない
- DistributorInstalled, DistributorAvailable, WorkingDirectory, DistributionDatabases, DistributionPublishers, RegisteredSubscribers, AgentCheckupIntervalなどの追加プロパティはSelect-Object *で取得可能
- このコマンドレットは他の多くのレプリケーションコマンドの基盤として使用される

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Add-ReplicationLibrary.ps1 | `private/functions/Add-ReplicationLibrary.ps1` | レプリケーションライブラリのロード方法 |

**読解のコツ**: Microsoft.SqlServer.Replication.ReplicationServerはRMO（Replication Management Objects）の中心的なクラスである。

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

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

**主要処理フロー**:
1. **83-85行目**: beginブロックでAdd-ReplicationLibraryを呼び出し
2. **90行目**: Connect-DbaInstanceで接続
3. **91行目**: New-Object Microsoft.SqlServer.Replication.ReplicationServerを作成
4. **92行目**: ConnectionContextを設定
5. **93-95行目**: メタデータを追加
6. **97行目**: Select-DefaultViewで出力

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Add-ReplicationLibrary.ps1 | `private/functions/Add-ReplicationLibrary.ps1` | ライブラリロード |
| 3-2 | Connect-DbaInstance | - | SQL Server接続 |

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

```
Get-DbaReplServer
    │
    ├─ Add-ReplicationLibrary (begin)
    │      └─ Add-Type Microsoft.SqlServer.Replication.dll
    │      └─ Add-Type Microsoft.SqlServer.Rmo.dll
    │
    ├─ Connect-DbaInstance
    │
    └─ New-Object Microsoft.SqlServer.Replication.ReplicationServer
```

### データフロー図

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

SqlInstance ──────────────────▶ Connect-DbaInstance ──────────────────▶ Server
                                      │
SqlCredential ────────────────▶ 認証処理
                                      │
                               New-Object ReplicationServer
                                      │
                               ConnectionContext設定
                                      │
                               メタデータ追加
                                      │
                               Select-DefaultView
                                      │
                                      ▼
                               ReplicationServerオブジェクト（7プロパティ）
                               (IsDistributor, IsPublisher等)
```

### 関連ファイル一覧

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