# 帳票設計書 11-Export-DbaLinkedServer

## 概要

本ドキュメントは、dbatools PowerShellモジュールの `Export-DbaLinkedServer` コマンドに関する帳票設計書です。このコマンドは、SQL Serverのリンクサーバー構成をT-SQLスクリプトとしてエクスポートする機能を提供します。

### 本帳票の処理概要

Export-DbaLinkedServerは、SQL Serverインスタンスに構成されているリンクサーバー定義を、再作成可能なT-SQLスクリプトとして出力するコマンドです。リモートログインマッピングとパスワードを含む完全なリンクサーバー構成をスクリプト化できます。

**業務上の目的・背景**：リンクサーバーは異なるSQL Serverインスタンス間や異種データソースとの連携に使用される重要な構成要素です。環境移行、災害復旧、構成ドキュメント化において、リンクサーバー設定を正確に再現する必要があります。手動で再構成する際のミスを防ぎ、移行作業の効率化を図るために本コマンドが必要とされます。

**帳票の利用シーン**：
- SQL Serverインスタンス間でのリンクサーバー設定の移行
- 災害復旧用のリンクサーバー構成バックアップ
- 本番環境からテスト環境へのリンクサーバー設定複製
- IT監査・コンプライアンス用の構成ドキュメント化

**主要な出力内容**：
1. リンクサーバー作成用のT-SQL文（sp_addlinkedserver等）
2. リモートログインマッピング設定（sp_addlinkedsrvlogin等）
3. パスワード情報（ExcludePassword指定時はプレースホルダー）
4. リンクサーバーオプション設定

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

**帳票の利用者**：データベース管理者（DBA）、インフラエンジニア、移行プロジェクトチーム

## 帳票種別

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

## 利用画面

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

## 出力形式

### 基本仕様

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

### SQL固有設定

| 項目 | 内容 |
|-----|------|
| バッチ区切り | なし（単一スクリプト） |
| コメント | なし |
| IF EXISTS チェック | なし |

## 帳票レイアウト

### レイアウト概要

T-SQLスクリプトとして出力されるため、従来の帳票レイアウトではなく、スクリプト構造として定義されます。

```
┌─────────────────────────────────────┐
│      リンクサーバー定義部            │
│   (sp_addlinkedserver ステートメント) │
├─────────────────────────────────────┤
│      リモートログイン設定部           │
│  (sp_addlinkedsrvlogin ステートメント)│
│        (パスワード情報含む)          │
└─────────────────────────────────────┘
```

### ヘッダー部

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

### 明細部

| No | 項目名 | 説明 | データ取得元 | 表示形式 | 列幅 |
|----|-------|------|-------------|---------|-----|
| 1 | LinkedServer名 | リンクサーバーの名前 | SMO LinkedServer.Name | T-SQL文内 | 可変 |
| 2 | Provider | OLEDBプロバイダー | SMO LinkedServer.Provider | T-SQL文内 | 可変 |
| 3 | DataSource | データソース | SMO LinkedServer.DataSource | T-SQL文内 | 可変 |
| 4 | RemoteUser | リモートログインユーザー | Get-DecryptedObject | T-SQL文内 | 可変 |
| 5 | Password | リモートログインパスワード | Get-DecryptedObject（復号化） | T-SQL文内 | 可変 |

### フッター部

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

## 出力条件

### 抽出条件

| 条件名 | 説明 | 必須 |
|-------|------|-----|
| SqlInstance | 対象SQL Serverインスタンス | Yes |
| LinkedServer | 特定のリンクサーバー名（指定時のみ） | No |
| ExcludePassword | パスワードを除外する場合はtrue | No |

### ソート順

| 優先度 | 項目 | 昇順/降順 |
|-------|------|---------|
| 1 | LinkedServer名 | 取得順（サーバー内部順） |

### 改ページ条件

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

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

### 参照テーブル一覧

| テーブル名 | 用途 | 結合条件 |
|-----------|------|---------|
| sys.servers | リンクサーバー一覧 | SMO経由でアクセス |
| sys.linked_logins | リンクサーバーログイン | SMO経由でアクセス |
| レジストリ | 暗号化パスワード取得 | DAC接続経由 |

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

#### SMO LinkedServers コレクション

| 参照項目（カラム名） | 帳票項目との対応 | 取得条件 | 備考 |
|-------------------|----------------|---------|------|
| Name | LinkedServer名 | - | スクリプト生成対象 |
| Provider | OLEDBプロバイダー | - | スクリプトに含む |
| DataSource | データソース | - | スクリプトに含む |

## 計算仕様

### 計算項目一覧

| 項目名 | 計算式 | 端数処理 | 備考 |
|-------|-------|---------|------|
| N/A | 計算処理なし | - | パスワードは復号化処理 |

## 処理フロー

### 出力フロー

```mermaid
flowchart TD
    A[Export-DbaLinkedServer実行] --> B{ExcludePassword?}
    B -->|Yes| C[通常接続]
    B -->|No| D[DAC接続でパスワード取得]
    C --> E[LinkedServers取得]
    D --> E
    E --> F{LinkedServer指定?}
    F -->|Yes| G[指定サーバーのみフィルタ]
    F -->|No| H[全サーバー対象]
    G --> I[スクリプト生成]
    H --> I
    I --> J{Passthru?}
    J -->|Yes| K[コンソール出力]
    J -->|No| L{Path/FilePath指定?}
    L -->|Yes| M[ファイル保存]
    L -->|No| K
    K --> N[終了]
    M --> N
```

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 表示メッセージ | 対処方法 |
|----------|---------|--------------|---------|
| 接続エラー | SQL Serverに接続できない | "Failure" | 接続情報を確認 |
| プラットフォーム非対応 | Linux/macOSで実行 | "This command is not supported on Linux or macOS" | Windowsで実行 |
| 書き込みエラー | ファイルに書き込めない | "Can't write to {FilePath}" | パス・権限を確認 |
| パスワード取得エラー | DAC接続失敗 | "Failure" | sysadmin権限を確認 |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定データ件数 | 1〜100リンクサーバー |
| 目標出力時間 | 30秒以内 |
| 同時出力数上限 | 制限なし（単一インスタンス処理） |

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

- パスワード取得にはDAC（専用管理者接続）が必要
- パスワードは平文でスクリプトに出力されるため、ファイル管理に注意
- ExcludePasswordオプションで安全なスクリプト生成が可能
- sysadmin権限が必要
- SQL Server 2005以上が必要

## 備考

- Windows専用コマンド（Linux/macOS非対応）
- パスワード復号化にはローカルレジストリへのアクセスが必要
- Appendオプションで既存ファイルへの追記が可能

---

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

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

### 推奨読解順序

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

リンクサーバーオブジェクトとパスワード復号化の仕組みを理解することが重要です。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Export-DbaLinkedServer.ps1 | `public/Export-DbaLinkedServer.ps1` | パラメータ定義（行99-113）でInputObjectがLinkedServer型を受け入れる |

**読解のコツ**: SMOのLinkedServerオブジェクトの構造を理解し、Script()メソッドがT-SQLを生成することを把握する

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

処理の起点となるprocess ブロックを特定します。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Export-DbaLinkedServer.ps1 | `public/Export-DbaLinkedServer.ps1` | process ブロック（行117-214）がメイン処理 |

**主要処理フロー**:
1. **行120-123**: Linux/macOSチェックで非対応プラットフォームを除外
2. **行126-151**: インスタンス接続とLinkedServers取得
3. **行166-192**: スクリプト生成（パスワード有無で分岐）
4. **行193-208**: 出力処理（ファイル/コンソール）

#### Step 3: パスワード復号化処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Export-DbaLinkedServer.ps1 | `public/Export-DbaLinkedServer.ps1` | Get-DecryptedObject呼び出し（行170） |

**主要処理フロー**:
- **行129-147**: DAC接続の判定と接続処理
- **行169-173**: Get-DecryptedObjectでパスワード復号化
- **行175-191**: 復号化されたパスワードをスクリプトに埋め込み

#### Step 4: ファイル出力処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | Export-DbaLinkedServer.ps1 | `public/Export-DbaLinkedServer.ps1` | 出力処理（行193-208） |

**主要処理フロー**:
- **行162**: Get-ExportFilePathでファイルパス決定
- **行197-201**: Append/Set-Contentによるファイル書き込み
- **行202**: Get-ChildItemでファイル情報を返却

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

```
Export-DbaLinkedServer
    │
    ├─ Test-ExportDirectory (begin)
    │      └─ パス存在確認
    │
    ├─ Test-FunctionInterrupt
    │      └─ 中断チェック
    │
    ├─ Connect-DbaInstance
    │      └─ SQL Server接続（DAC含む）
    │
    ├─ Get-DecryptedObject
    │      └─ パスワード復号化（レジストリアクセス）
    │
    ├─ LinkedServer.Script()
    │      └─ SMOによるT-SQL生成
    │
    ├─ Get-ExportFilePath
    │      └─ 出力ファイルパス決定
    │
    └─ Set-Content / Add-Content
           └─ ファイル出力
```

### データフロー図

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

SqlInstance ───────▶ Connect-DbaInstance ───────▶ Server Object
                            │
                            ▼
LinkedServer ──────▶ Filter by Name ────────────▶ Filtered LinkedServers
                            │
                            ▼
                     Get-DecryptedObject ───────▶ Decrypted Passwords
                            │
                            ▼
                     LinkedServer.Script() ─────▶ T-SQL Script
                            │
                            ▼
                     Replace Passwords ──────────▶ Complete Script
                            │
                            ▼
Path/FilePath ─────▶ Set-Content/Add-Content ───▶ .sql File
    or
Passthru ──────────▶ Console Output ────────────▶ String Output
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Export-DbaLinkedServer.ps1 | `public/Export-DbaLinkedServer.ps1` | ソース | メイン処理 |
| Export-DbaLinkedServer.Tests.ps1 | `tests/Export-DbaLinkedServer.Tests.ps1` | テスト | 単体テスト |
| Connect-DbaInstance.ps1 | `public/Connect-DbaInstance.ps1` | ソース | DB接続処理 |
| Get-DecryptedObject.ps1 | `private/Get-DecryptedObject.ps1` | ソース | パスワード復号化 |
| Get-ExportFilePath.ps1 | `private/Get-ExportFilePath.ps1` | ソース | 出力パス決定 |
| Test-ExportDirectory.ps1 | `private/Test-ExportDirectory.ps1` | ソース | ディレクトリ検証 |
