# 帳票設計書 20-Export-DbaReplServerSetting

## 概要

本ドキュメントは、dbatools PowerShellモジュールの `Export-DbaReplServerSetting` コマンドに関する帳票設計書です。このコマンドは、SQLレプリケーションディストリビューター・パブリケーション構成をT-SQLスクリプトとして生成する機能を提供します。

### 本帳票の処理概要

Export-DbaReplServerSettingは、SQL Serverレプリケーション環境のディストリビューター構成、パブリケーション定義、サブスクリプション設定を含む完全なレプリケーション構成をT-SQLスクリプトとしてエクスポートするコマンドです。災害復旧やレプリケーション環境の移行・再構築に使用できるスクリプトを生成します。

**業務上の目的・背景**：レプリケーションは複雑な設定を持つ分散データアーキテクチャの重要コンポーネントです。災害復旧時のレプリケーション再構築、環境移行、構成変更のドキュメント化、監査対応において、レプリケーション設定の正確な再現が必要です。本コマンドにより、手動でのレプリケーション再設定を不要とし、一貫したレプリケーション環境を維持できます。

**帳票の利用シーン**：
- 災害復旧計画の一部としてのレプリケーション構成バックアップ
- レプリケーション環境の移行（サーバー入替え時）
- レプリケーション構成のドキュメント化・監査対応
- 開発・テスト環境でのレプリケーション再現
- 構成変更前のバックアップ

**主要な出力内容**：
1. sp_dropdistributor実行文（クリーンアップ用）
2. ディストリビューター構成スクリプト
3. パブリケーション定義スクリプト
4. サブスクリプション設定スクリプト

**帳票の出力タイミング**：PowerShellコンソールまたはスクリプトからコマンド実行時に即座に出力されます。

**帳票の利用者**：データベース管理者（DBA）、レプリケーション管理者、DR担当者

## 帳票種別

スクリプトファイル（T-SQL形式）

## 利用画面

| 画面No | 画面名 | URL/ルーティング | 出力操作 |
|--------|--------|-----------------|---------|
| N/A | PowerShellコンソール | コマンドライン | Export-DbaReplServerSetting コマンド実行 |

## 出力形式

### 基本仕様

| 項目 | 内容 |
|-----|------|
| ファイル形式 | SQL（T-SQLスクリプト） |
| 用紙サイズ | N/A（テキストファイル） |
| 向き | N/A |
| ファイル名 | {ServerName}-{timestamp}.sql |
| 出力方法 | ファイル保存 / コンソール出力（Passthru） |
| 文字コード | UTF-8（デフォルト、変更可能） |

### SQL固有設定

| 項目 | 内容 |
|-----|------|
| バッチ区切り | なし |
| コメント | なし |
| クリーンアップ | sp_dropdistributor含む |

## 帳票レイアウト

### レイアウト概要

T-SQLスクリプトとして出力されます。

```
┌─────────────────────────────────────┐
│      ディストリビュータークリーンアップ │
│   exec sp_dropdistributor           │
│     @no_checks = 1,                 │
│     @ignore_distributor = 1         │
├─────────────────────────────────────┤
│      ディストリビューター構成        │
│   (sp_adddistributor等)             │
├─────────────────────────────────────┤
│      パブリケーション定義            │
│   (sp_addpublication等)             │
├─────────────────────────────────────┤
│      サブスクリプション設定          │
│   (sp_addsubscription等)            │
└─────────────────────────────────────┘
```

### ヘッダー部

| No | 項目名 | 説明 | データ取得元 | 表示形式 |
|----|-------|------|-------------|---------|
| 1 | クリーンアップ | ディストリビューター削除 | 固定 | exec sp_dropdistributor... |

### 明細部

| No | 項目名 | 説明 | データ取得元 | 表示形式 | 列幅 |
|----|-------|------|-------------|---------|-----|
| 1 | ディストリビューター | ディストリビューター設定 | ReplServer.Script() | T-SQL | 可変 |
| 2 | パブリケーション | パブリケーション定義 | ReplServer.Script() | T-SQL | 可変 |
| 3 | サブスクリプション | サブスクリプション設定 | ReplServer.Script() | T-SQL | 可変 |

### フッター部

| No | 項目名 | 説明 | データ取得元 | 表示形式 |
|----|-------|------|-------------|---------|
| 1 | N/A | なし | - | - |

## 出力条件

### 抽出条件

| 条件名 | 説明 | 必須 |
|-------|------|-----|
| SqlInstance | 対象SQL Serverインスタンス | Yes（InputObjectがない場合） |
| ScriptOption | カスタムスクリプトオプション | No |

### ソート順

| 優先度 | 項目 | 昇順/降順 |
|-------|------|---------|
| 1 | サーバー順 | InputObject順 |

### 改ページ条件

N/A（テキストファイル出力のため）

## データベース参照仕様

### 参照テーブル一覧

| テーブル名 | 用途 | 結合条件 |
|-----------|------|---------|
| distribution.dbo.MSdistributor | ディストリビューター情報 | RMO経由 |
| distribution.dbo.MSpublications | パブリケーション情報 | RMO経由 |
| distribution.dbo.MSsubscriptions | サブスクリプション情報 | RMO経由 |

### テーブル別参照項目詳細

#### ReplServer.Script()

| 参照項目（カラム名） | 帳票項目との対応 | 取得条件 | 備考 |
|-------------------|----------------|---------|------|
| Distributor設定 | ディストリビューター構成 | ScriptOption | RMO Script()メソッド |
| Publication設定 | パブリケーション定義 | ScriptOption | RMO Script()メソッド |

## 計算仕様

### 計算項目一覧

| 項目名 | 計算式 | 端数処理 | 備考 |
|-------|-------|---------|------|
| N/A | 計算処理なし | - | スクリプト生成のみ |

## 処理フロー

### 出力フロー

```mermaid
flowchart TD
    A[Export-DbaReplServerSetting実行] --> B[Add-ReplicationLibrary]
    B --> C{SqlInstance指定?}
    C -->|Yes| D[Get-DbaReplServer]
    C -->|No| E[InputObject使用]
    D --> F[ループ: 各ReplServer]
    E --> F
    F --> G[Get-ExportFilePath]
    G --> H{ScriptOption指定?}
    H -->|No| I[デフォルトオプション使用]
    H -->|Yes| J[指定オプション使用]
    I --> K[ReplServer.Script実行]
    J --> K
    K --> L{Passthru?}
    L -->|Yes| M[コンソール出力]
    L -->|No| N[ファイル出力]
    M --> O{次サーバー?}
    N --> O
    O -->|Yes| F
    O -->|No| P[終了]
```

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 表示メッセージ | 対処方法 |
|----------|---------|--------------|---------|
| レプリケーション未設定 | レプリケーション構成なし | "Replication export failed. Is it setup?" | レプリケーション構成確認 |
| ライブラリエラー | RMOライブラリなし | Add-ReplicationLibrary エラー | SSMS/SMOインストール確認 |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定データ件数 | 1〜10サーバー |
| 目標出力時間 | 30秒以内 |
| 同時出力数上限 | 制限なし |

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

- sysadmin権限またはdb_owner（distribution）が必要
- レプリケーションの接続情報が含まれる可能性
- SSMSインストールが必要（RMOライブラリ）
- 現在Linux/macOS非対応（RMO要件）

## 備考

- Add-ReplicationLibraryでRMOライブラリをロード
- デフォルトScriptOption: Creation, IncludeAll, EnableReplicationDB, IncludeInstallDistributor
- sp_dropdistributorをスクリプト先頭に含む（クリーンインストール用）
- SSMSインストールが前提条件

---

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

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

### 推奨読解順序

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

RMO（Replication Management Objects）とScriptOptionsの仕組みを理解することが重要です。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Export-DbaReplServerSetting.ps1 | `public/Export-DbaReplServerSetting.ps1` | パラメータ定義（行98-113）でScriptOption等を確認 |

**読解のコツ**: Microsoft.SqlServer.Replication名前空間のReplServerオブジェクトを理解する

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Export-DbaReplServerSetting.ps1 | `public/Export-DbaReplServerSetting.ps1` | beginブロック（行114-117） |
| 2-2 | Export-DbaReplServerSetting.ps1 | `public/Export-DbaReplServerSetting.ps1` | processブロック（行118-149） |

**主要処理フロー**:
1. **行115-116**: Add-ReplicationLibrary、Test-ExportDirectory
2. **行120-122**: Get-DbaReplServerでReplServer取得
3. **行124-125**: Get-ExportFilePathでパス決定

#### Step 3: スクリプト生成処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Export-DbaReplServerSetting.ps1 | `public/Export-DbaReplServerSetting.ps1` | Script処理（行127-143） |

**主要処理フロー**:
- **行128-133**: デフォルトScriptOption（Creation, IncludeAll等）
- **行134-136**: カスタムScriptOption使用時
- **行140-143**: Passthru時のコンソール出力
- **行146-147**: ファイル出力

#### Step 4: デフォルトオプションを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | Export-DbaReplServerSetting.ps1 | `public/Export-DbaReplServerSetting.ps1` | ScriptOptions（行129-132） |

**主要処理フロー**:
- **行129**: Creation - 作成スクリプト生成
- **行130**: IncludeAll - 全オブジェクト含む
- **行131**: EnableReplicationDB - レプリケーションDB有効化
- **行132**: IncludeInstallDistributor - ディストリビューターインストール含む

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

```
Export-DbaReplServerSetting
    │
    ├─ Add-ReplicationLibrary (begin)
    │      └─ RMOライブラリロード
    │
    ├─ Test-ExportDirectory (begin)
    │      └─ パス存在確認
    │
    ├─ Get-DbaReplServer
    │      └─ ReplServerオブジェクト取得
    │
    ├─ Get-ExportFilePath
    │      └─ 出力ファイルパス決定
    │
    ├─ ReplServer.Script()
    │      └─ T-SQL生成（ScriptOptions適用）
    │
    └─ Out-File
           └─ ファイル出力
```

### データフロー図

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

SqlInstance ───────▶ Get-DbaReplServer ──────────▶ ReplServer Object
                            │
                            ▼
ScriptOption ──────▶ ReplServer.Script() ────────▶ T-SQL Script
                            │
                            ▼
                     sp_dropdistributor追加 ─────▶ Complete Script
                            │
                            ▼
Path/FilePath ─────▶ Out-File ───────────────────▶ .sql File
    or
Passthru ──────────▶ Out-String ─────────────────▶ Console Output
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Export-DbaReplServerSetting.ps1 | `public/Export-DbaReplServerSetting.ps1` | ソース | メイン処理 |
| Export-DbaReplServerSetting.Tests.ps1 | `tests/Export-DbaReplServerSetting.Tests.ps1` | テスト | 単体テスト |
| Get-DbaReplServer.ps1 | `public/Get-DbaReplServer.ps1` | ソース | ReplServer取得 |
| Add-ReplicationLibrary.ps1 | `private/Add-ReplicationLibrary.ps1` | ソース | RMOライブラリロード |
| Get-ExportFilePath.ps1 | `private/Get-ExportFilePath.ps1` | ソース | 出力パス決定 |
| Test-ExportDirectory.ps1 | `private/Test-ExportDirectory.ps1` | ソース | ディレクトリ検証 |
