# 機能設計書 388-Export-DbaPfDataCollectorSetTemplate

## 概要

本ドキュメントは、dbatools PowerShellモジュールにおけるExport-DbaPfDataCollectorSetTemplate機能の設計仕様を記載する。本機能は、Windows Performance Monitor Data Collector Set設定を再利用可能なXMLテンプレートとしてエクスポートする。

### 本機能の処理概要

本機能は、Windows Performance MonitorからData Collector Set設定をXMLテンプレートファイルとしてエクスポートし、他のSQL Serverホストにインポートできるようにする。カスタムカウンターコレクション、サンプリング間隔、出力設定を含む完全な設定を、移植可能なテンプレートとして保存できる。

**業務上の目的・背景**：SQL Server環境全体でパフォーマンスモニタリングを標準化するには、検証済みの設定を他のサーバーに迅速に展開できる必要がある。本機能により、カスタムパフォーマンスベースラインやトラブルシューティング設定をXMLテンプレートとして保存し、必要時に素早くデプロイできる。

**機能の利用シーン**：
- 検証済みモニタリング設定のテンプレート化
- 新規サーバーへの標準設定展開準備
- 設定のバックアップと文書化
- 環境間での設定共有

**主要な処理内容**：
1. 対象のData Collector SetをGet-DbaPfDataCollectorSetで取得（または入力オブジェクトから）
2. Data Collector SetのXML設定を抽出
3. ファイル名のサニタイズ（無効文字の除去）
4. XMLをUnicodeエンコーディングでファイルに書き込み
5. FileInfoオブジェクトを出力

**関連システム・外部連携**：Windows Performance Monitor、ファイルシステム。

**権限による制御**：Data Collector Set設定の読み取り権限とエクスポート先フォルダへの書き込み権限が必要。

## 関連画面

本機能はCLIベースのPowerShellコマンドレットであり、GUI画面との直接的な関連はない。

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | PowerShellコンソール | 主画面 | コマンド実行とエクスポート結果表示 |
| - | Windows Performance Monitor | 参照画面 | エクスポート元のData Collector Set確認 |

## 機能種別

ファイルエクスポート / 設定バックアップ

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| ComputerName | DbaInstance[] | No | エクスポート元コンピュータ。デフォルトはローカル | - |
| Credential | PSCredential | No | リモートコンピュータ接続用資格情報 | - |
| CollectorSet | string[] | No | エクスポートするData Collector Set名（エイリアス: DataCollectorSet） | - |
| Path | string | No | XMLファイル出力ディレクトリ | Path.DbatoolsExportがデフォルト |
| FilePath | string | No | 出力ファイルの完全パス（エイリアス: OutFile, FileName） | - |
| InputObject | object[] | No | Get-DbaPfDataCollectorSetからのパイプライン入力 | ValueFromPipeline |
| EnableException | switch | No | 例外処理の有効化 | - |

### 入力データソース

- パイプライン入力：InputObjectがValueFromPipelineをサポート
- Get-DbaPfDataCollectorSetからのData Collector Setオブジェクト

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| - | System.IO.FileInfo | エクスポートされたXMLテンプレートファイル |

FileInfoオブジェクトのプロパティ：
| プロパティ | 説明 |
|-----------|------|
| Name | ファイル名（例: 'System Correlation.xml'） |
| FullName | ファイルの完全パス |
| Directory | 親フォルダ |
| Length | ファイルサイズ（バイト） |
| CreationTime | 作成日時 |
| LastWriteTime | 最終更新日時 |
| Extension | ファイル拡張子（.xml） |

### 出力先

- ファイル：指定されたPath/FilePathにXMLファイルを作成
- パイプライン：FileInfoオブジェクト

## 処理フロー

### 処理シーケンス

```
1. エクスポート先ディレクトリの検証
   └─ Test-ExportDirectory
2. 入力の処理
   └─ InputObjectのCredentialを継承（未指定時）
3. Data Collector Setの取得
   └─ InputObject未指定時: Get-DbaPfDataCollectorSetで取得
4. 入力検証
   └─ DataCollectorSetObjectプロパティの存在確認
5. ファイル名の決定
   └─ FilePath未指定時: Path + CollectorSet名 + .xml
   └─ ファイル名の無効文字をサニタイズ
6. XMLのエクスポート
   └─ Set-ContentでUnicodeエンコーディングで書き込み
7. FileInfoオブジェクト出力
   └─ Get-ChildItemで作成されたファイルを取得
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[Test-ExportDirectory]
    B --> C{InputObjectにCredentialあり?}
    C -->|Yes| D[Credentialを継承]
    C -->|No| E{InputObject指定あり?}
    D --> E
    E -->|No| F[Get-DbaPfDataCollectorSetで取得]
    E -->|Yes| G{DataCollectorSetObject存在?}
    F --> G
    G -->|No| H[エラー: 不正な入力タイプ]
    G -->|Yes| I[各Data Collector Setでループ]
    I --> J{FilePath指定?}
    J -->|No| K[CollectorSet名からファイルパス生成]
    J -->|Yes| L[指定FilePathを使用]
    K --> M[無効文字のサニタイズ]
    M --> N[Set-ContentでXML書き込み]
    L --> N
    N --> O[Get-ChildItemでFileInfo取得]
    O --> P[FileInfo出力]
    P --> Q{次のData Collector Setあり?}
    Q -->|Yes| I
    Q -->|No| R[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | デフォルトエクスポートパス | Path.DbatoolsExport設定値を使用 | Path未指定時 |
| BR-002 | ファイル名サニタイズ | Remove-InvalidFileNameCharsで無効文字除去 | 常時 |
| BR-003 | Unicodeエンコーディング | XMLはUnicodeエンコーディングで保存 | 常時 |
| BR-004 | 拡張子自動付加 | .xmlが自動的に付加される | 常時 |

### 計算ロジック

ファイルパス生成:
```powershell
$csname = Remove-InvalidFileNameChars -Name $object.Name
$FilePath = "$Path\$csname.xml"
```

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

本機能はデータベースを操作しない。

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| なし | - | - | ファイルシステム操作のみ |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | 入力タイプエラー | DataCollectorSetObjectプロパティがない | Get-DbaPfDataCollectorSetからの入力を使用 |
| - | 書き込みエラー | エクスポート先への書き込み権限なし | 権限のあるパスを指定 |
| - | パス不正 | 指定されたPathが存在しない | 有効なパスを指定 |

### リトライ仕様

リトライ機能は実装されていない。

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

ファイル書き込みのため、トランザクション管理は実装されていない。

## パフォーマンス要件

- XML出力は軽量な操作
- 複数Data Collector Setのエクスポートは順次処理

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

- エクスポート先ディレクトリへの書き込み権限が必要
- Credentialパラメータでリモート認証可能

## 備考

- Get-DbaPfDataCollectorSetとパイプラインで連携
- エクスポートしたXMLはImport-DbaPfDataCollectorSetTemplateでインポート可能

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Export-DbaPfDataCollectorSetTemplate.ps1 | `public/Export-DbaPfDataCollectorSetTemplate.ps1` | 出力型（50-64行目の.OUTPUTS） |

**読解のコツ**: 出力はSystem.IO.FileInfo型。XMLの内容はData Collector Setの完全な設定。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Export-DbaPfDataCollectorSetTemplate.ps1 | `public/Export-DbaPfDataCollectorSetTemplate.ps1` | パラメータ定義（75-87行目） |
| 2-2 | Export-DbaPfDataCollectorSetTemplate.ps1 | `public/Export-DbaPfDataCollectorSetTemplate.ps1` | beginブロック（88-90行目） |

**主要処理フロー**:
1. **75-87行目**: パラメータ定義。PathはPath.DbatoolsExportがデフォルト
2. **89行目**: Test-ExportDirectoryでエクスポート先検証

#### Step 3: コア処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Export-DbaPfDataCollectorSetTemplate.ps1 | `public/Export-DbaPfDataCollectorSetTemplate.ps1` | 入力処理とData Collector Set取得（91-102行目） |
| 3-2 | Export-DbaPfDataCollectorSetTemplate.ps1 | `public/Export-DbaPfDataCollectorSetTemplate.ps1` | XMLエクスポート（104-118行目） |

**主要処理フロー**:
- **94-96行目**: InputObjectのCredential継承
- **98-101行目**: Get-DbaPfDataCollectorSetでの取得
- **104-108行目**: 入力タイプ検証
- **110-113行目**: ファイルパス生成
- **115-117行目**: Set-ContentでXML書き込み、Get-ChildItemで結果取得

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

```
Export-DbaPfDataCollectorSetTemplate
    │
    ├─ Test-ExportDirectory
    │      └─ エクスポート先ディレクトリ検証
    │
    ├─ Get-DbaPfDataCollectorSet
    │      └─ Data Collector Setオブジェクト取得
    │
    ├─ Remove-InvalidFileNameChars
    │      └─ ファイル名サニタイズ
    │
    ├─ Set-Content
    │      └─ XMLファイル書き込み
    │
    └─ Get-ChildItem
           └─ FileInfoオブジェクト取得
```

### データフロー図

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

ComputerName ───┐
                │
CollectorSet ───┤
                │
Path ───────────┼──▶ Get-DbaPfDataCollector ──▶ System.IO.FileInfo
                │    Set                        │
InputObject ────┘    ▼                          ├─ Name
                     XML抽出                    ├─ FullName
                     ▼                          ├─ Directory
                     Set-Content                ├─ Length
                     (Unicode)                  └─ Extension
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Export-DbaPfDataCollectorSetTemplate.ps1 | `public/Export-DbaPfDataCollectorSetTemplate.ps1` | ソース | メイン機能実装 |
| Export-DbaPfDataCollectorSetTemplate.Tests.ps1 | `tests/Export-DbaPfDataCollectorSetTemplate.Tests.ps1` | テスト | 単体テスト |
| Get-DbaPfDataCollectorSet.ps1 | `public/Get-DbaPfDataCollectorSet.ps1` | 依存 | Data Collector Set取得 |
| Import-DbaPfDataCollectorSetTemplate.ps1 | `public/Import-DbaPfDataCollectorSetTemplate.ps1` | 関連 | テンプレートインポート |
