# 機能設計書 142-Get-DbaRandomizedDatasetTemplate

## 概要

本ドキュメントは、dbatools PowerShellモジュールにおける`Get-DbaRandomizedDatasetTemplate`コマンドレットの機能設計を定義する。本機能は、テストデータ生成用のJSONテンプレートファイルを取得し、Get-DbaRandomizedDatasetで使用可能なテンプレート情報を提供する。

### 本機能の処理概要

`Get-DbaRandomizedDatasetTemplate`は、デフォルトおよびカスタムディレクトリからJSONテンプレートファイルを検索・取得するコマンドレットである。テンプレートは列名、データ型、セマンティックサブタイプ（Name.FirstName、Address.Cityなど）を定義し、構造化されたサンプルデータを生成するための基盤を提供する。

**業務上の目的・背景**：テストデータ生成において、どのようなテンプレートが利用可能かを把握することは重要である。本機能は利用可能なテンプレートの一覧取得と、カスタムテンプレートの追加管理を容易にする。組織固有のデータパターンを持つカスタムテンプレートを追加することで、より実際の業務データに近いテストデータを生成できる。

**機能の利用シーン**：
- 利用可能なテストデータテンプレートの確認
- カスタムテンプレートディレクトリからのテンプレート検索
- Get-DbaRandomizedDatasetへのパイプライン入力としてのテンプレート取得
- テンプレート名によるフィルタリング検索
- デフォルトテンプレートを除外したカスタムテンプレートのみの取得

**主要な処理内容**：
1. デフォルトテンプレートディレクトリ（module\bin\randomizer\templates）からJSONファイルを取得
2. 指定されたPathパラメータからカスタムテンプレートを追加取得
3. Templateパラメータによる名前フィルタリング
4. BaseName（拡張子なしのファイル名）とFullName（フルパス）を出力

**関連システム・外部連携**：
- Get-DbaRandomizedDataset（データ生成機能への入力）
- ファイルシステム（テンプレートファイルの読み込み）

**権限による制御**：本機能はファイルシステムへの読み取りアクセスのみを使用する。SQL Server接続は不要。カスタムパスへのアクセスにはファイルシステムレベルの読み取り権限が必要。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | CLIコマンド | 主機能 | テンプレート一覧取得 |

## 機能種別

データ取得処理

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| Template | string[] | No | フィルタリングするテンプレート名（.json拡張子なし） | - |
| Path | string[] | No | カスタムテンプレートディレクトリパス | 有効なディレクトリパス |
| ExcludeDefault | switch | No | 組み込みテンプレートを除外 | - |
| EnableException | switch | No | 例外を有効化 | - |

### 入力データソース

- デフォルトテンプレートディレクトリ: `$script:PSModuleRoot\bin\randomizer\templates\`
- カスタムテンプレートディレクトリ: Pathパラメータで指定

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| BaseName | string | テンプレート名（.json拡張子なし） |
| FullName | string | テンプレートファイルのフルパス |

### 出力先

パイプライン（PSCustomObject）

## 処理フロー

### 処理シーケンス

```
1. 初期化（begin）
   └─ 空のテンプレート配列を作成
2. デフォルトテンプレート取得
   └─ ExcludeDefaultが未指定の場合、bin\randomizer\templates\*.jsonを取得
3. カスタムテンプレート取得（process）
   └─ Pathパラメータの各ディレクトリから*.jsonを取得
4. テンプレートフィルタリング
   └─ Templateパラメータ指定時、BaseNameでフィルタリング
5. 出力
   └─ BaseName, FullNameを選択して出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[begin: 空配列初期化]
    B --> C{ExcludeDefault<br/>指定あり?}
    C -->|No| D[デフォルトディレクトリから<br/>*.json取得]
    C -->|Yes| E[デフォルトテンプレート<br/>スキップ]
    D --> F[process開始]
    E --> F
    F --> G{Pathパラメータ<br/>指定あり?}
    G -->|Yes| H[各Pathディレクトリから<br/>*.json取得]
    G -->|No| I[パス追加なし]
    H --> J[テンプレート配列に追加]
    I --> K{Templateパラメータ<br/>指定あり?}
    J --> K
    K -->|Yes| L[BaseNameで<br/>フィルタリング]
    K -->|No| M[フィルタなし]
    L --> N[Select-Object<br/>BaseName, FullName]
    M --> N
    N --> O[パイプライン出力]
    O --> P[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | デフォルトテンプレート包含 | ExcludeDefault未指定時はデフォルトテンプレートを含む | ExcludeDefault未指定 |
| BR-002 | テンプレート名フィルタ | TemplateパラメータはBaseNameと完全一致で検索 | Template指定時 |
| BR-003 | 複数パス対応 | Pathパラメータは複数ディレクトリを指定可能 | Path指定時 |
| BR-004 | JSON拡張子限定 | 取得対象は*.jsonファイルのみ | 常時 |

### 計算ロジック

特になし

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

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

本機能はデータベースへのアクセスを行わない。

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| - | - | - | データベースアクセスなし |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ファイルアクセスエラー | 指定パスが存在しないまたはアクセス不可 | パスを確認 |
| - | テンプレート未発見 | フィルタ条件に一致するテンプレートなし | テンプレート名を確認 |

### リトライ仕様

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

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

データベーストランザクションは使用しない。

## パフォーマンス要件

- ファイルシステムスキャンのみのため、高速に動作
- 大量のテンプレートファイルがある場合でも影響は軽微

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

- ファイルシステムへの読み取りアクセスのみ
- カスタムパス指定時はOSレベルのアクセス制御に依存

## 備考

- デフォルトテンプレートにはPersonalDataなど一般的なPII関連フィールドが含まれる
- カスタムテンプレートは組織固有のデータパターンを定義可能

---

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

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

### 推奨読解順序

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

出力オブジェクトの構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Get-DbaRandomizedDatasetTemplate.ps1 | `public/Get-DbaRandomizedDatasetTemplate.ps1` | 出力オブジェクト構造（BaseName, FullName） |

**読解のコツ**: 出力は103行目のSelect-Objectで定義されている。FileInfoオブジェクトからBaseName（拡張子なしファイル名）とFullName（フルパス）のみを選択して出力している。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Get-DbaRandomizedDatasetTemplate.ps1 | `public/Get-DbaRandomizedDatasetTemplate.ps1` | 全体処理フロー |

**主要処理フロー**:
1. **81-88行目**: begin ブロック - デフォルトテンプレート取得
2. **85-87行目**: ExcludeDefault未指定時のデフォルトテンプレート取得
3. **90-96行目**: process ブロック - カスタムパスからのテンプレート追加
4. **94-96行目**: Pathパラメータの各ディレクトリからJSON取得
5. **99-101行目**: Templateパラメータによるフィルタリング
6. **103行目**: Select-Objectでの出力形成

#### Step 3: 関連機能との連携を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Get-DbaRandomizedDataset.ps1 | `public/Get-DbaRandomizedDataset.ps1` | テンプレート使用側の実装 |

**主要処理フロー**:
- **133行目**: Get-DbaRandomizedDatasetTemplateの呼び出し
- **142行目**: InputObjectとしてテンプレートを受け取り
- **145行目**: FullNameプロパティを使用してファイル読み込み

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

```
Get-DbaRandomizedDatasetTemplate
    │
    ├─ Get-ChildItem（デフォルトテンプレート取得）
    │      └─ bin/randomizer/templates/*.json
    │
    ├─ Get-ChildItem（カスタムテンプレート取得）
    │      └─ $Path/*.json
    │
    ├─ Where-Object（Templateフィルタリング）
    │
    └─ Select-Object BaseName, FullName
```

### データフロー図

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

                    Get-ChildItem
                    (デフォルトディレクトリ)
                          │
ExcludeDefault ────▶  フィルタ判定
                          │
                          ▼
Path[] ──────────▶  Get-ChildItem  ────▶  テンプレート配列
                    (カスタムディレクトリ)         │
                                                   ▼
Template[] ────────────────────────────▶  Where-Object
                                          (BaseNameフィルタ)
                                                   │
                                                   ▼
                                          Select-Object
                                          BaseName, FullName
                                                   │
                                                   ▼
                                          [PSCustomObject]
                                          - BaseName
                                          - FullName
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Get-DbaRandomizedDatasetTemplate.ps1 | `public/Get-DbaRandomizedDatasetTemplate.ps1` | ソース | メイン機能 |
| Get-DbaRandomizedDataset.ps1 | `public/Get-DbaRandomizedDataset.ps1` | ソース | 呼び出し元機能 |
| *.json | `bin/randomizer/templates/` | テンプレート | デフォルトテンプレートファイル |
