# 機能設計書 668-Export-DbaDbTableData

## 概要

本ドキュメントは、テーブルデータからINSERTステートメントを生成してマイグレーションおよびデプロイメントスクリプトを作成するExport-DbaDbTableData機能の設計仕様を記述したものである。

### 本機能の処理概要

Export-DbaDbTableDataは、既存のテーブルデータから実行可能なINSERTステートメントを作成し、SQL Serverインスタンスや環境間でデータを移動しやすくする機能である。

**業務上の目的・背景**：テーブル構造だけでなく実際のデータ値が必要な参照テーブル、ルックアップデータ、または構成テーブルをマイグレーションする際に特に有用である。生成されたスクリプトには適切なUSEデータベースコンテキストが含まれ、ファイルに保存したり、さらなる処理のために他のコマンドにパイプすることができる。

**機能の利用シーン**：
- マスタデータや参照テーブルのエクスポート
- デプロイメントスクリプトへのデータ組込み
- バージョン管理システムへのデータ保存
- 環境間データ移行スクリプトの作成
- テスト用初期データスクリプトの生成

**主要な処理内容**：
1. テーブルオブジェクトの受け取り
2. ScriptingOptionsの設定（データスクリプト有効化）
3. Export-DbaScriptへの委譲
4. INSERTステートメントの生成
5. ファイル出力またはPassthru出力

**関連システム・外部連携**：内部的にExport-DbaScriptを呼び出し、SMOのスクリプティング機能を使用してINSERTステートメントを生成する。

**権限による制御**：対象テーブルに対するSELECT権限が必要。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | PowerShellコンソール | 主画面 | コマンド実行とスクリプト出力 |

## 機能種別

データエクスポート / スクリプト生成

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| InputObject | Table[] | Yes | エクスポート対象テーブル | パイプライン入力必須 |
| Path | string | No | 出力ディレクトリ | デフォルト: dbatools export path |
| FilePath | string | No | 出力ファイルパス | 完全パス指定 |
| Encoding | string | No | ファイルエンコーディング | デフォルト: UTF8 |
| BatchSeparator | string | No | バッチ区切り文字 | デフォルト: 空文字 |
| NoPrefix | switch | No | USEステートメント除外 | - |
| Passthru | switch | No | コンソール出力 | - |
| NoClobber | switch | No | 上書き禁止 | - |
| Append | switch | No | ファイル追記 | - |
| EnableException | switch | No | 例外を有効化 | - |

### 入力データソース

- InputObject: Get-DbaDbTableからパイプライン入力（必須）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| (FileInfo) | System.IO.FileInfo | 生成されたファイル情報 |
| (String) | System.String | Passthru時のINSERTステートメント |

### 出力先

- ファイル: Path/FilePathで指定
- コンソール: Passthru指定時

## 処理フロー

### 処理シーケンス

```
1. beginブロック：ScriptingOptions設定
   └─ ScriptSchema=false, ScriptData=true, IncludeDatabaseContext=true
2. processブロック：Export-DbaScript呼び出し
   └─ PSBoundParametersとScriptingOptionsObjectを渡す
3. Export-DbaScriptによるINSERTステートメント生成
   └─ SMOスクリプティング機能使用
4. ファイル出力またはPassthru出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[ScriptingOptions設定]
    B --> C{ShouldProcess?}
    C -->|Yes| D[Export-DbaScript呼び出し]
    C -->|No| E[終了]
    D --> F{Passthru?}
    F -->|Yes| G[コンソール出力]
    F -->|No| H[ファイル出力]
    G --> E
    H --> E
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-668-1 | データのみ | ScriptSchema=falseでテーブル定義は除外 | 常時 |
| BR-668-2 | DBコンテキスト | IncludeDatabaseContext=trueでUSE文含む | NoPrefix未指定時 |
| BR-668-3 | デフォルトパス | Path未指定時はdbatools設定のエクスポートパス使用 | 常時 |
| BR-668-4 | エンコーディング | デフォルトはUTF8 | 常時 |

### 計算ロジック

特になし。スクリプト生成はExport-DbaScriptに委譲。

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| 読取 | 指定テーブル | SELECT | データ読み取り（スクリプト生成） |

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

#### 指定テーブル (SMO経由)

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| SELECT | 全列 | 全データ | SMOスクリプティング経由 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | Export-DbaScript内 | 各種エラー | Export-DbaScriptに委譲 |

### リトライ仕様

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

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

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

## パフォーマンス要件

- 大量データを含むテーブルでは生成されるスクリプトファイルが大きくなる可能性
- SMOスクリプティングによるメモリ使用量に注意

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

- センシティブなデータを含むテーブルのエクスポートに注意
- 出力ファイルのアクセス権限管理が必要
- NoClobberで既存ファイルの誤上書き防止

## 備考

- 内部的にはExport-DbaScriptのラッパー
- New-DbaScriptingOptionでカスタムオプションを使用する場合はExport-DbaScriptを直接使用
- BatchSeparatorを指定してGOを追加可能
- Append指定で複数テーブルのデータを1ファイルに集約可能

---

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

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

### 推奨読解順序

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

ScriptingOptionsと出力形式を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Export-DbaDbTableData.ps1 | `public/Export-DbaDbTableData.ps1` | ScriptingOptionsの設定 |

**読解のコツ**: beginブロックでNew-DbaScriptingOptionを呼び出し、ScriptSchemaとScriptDataを設定している。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Export-DbaDbTableData.ps1 | `public/Export-DbaDbTableData.ps1` | メイン処理（わずか20行程度） |

**主要処理フロー**:
1. **127-131行目**: beginブロック - ScriptingOptions設定
2. **128行目**: New-DbaScriptingOption呼び出し
3. **129行目**: ScriptSchema = $false
4. **130行目**: ScriptData = $true
5. **131行目**: IncludeDatabaseContext = $true
6. **134-137行目**: processブロック - Export-DbaScript呼び出し

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Export-DbaScript | `public/Export-DbaScript.ps1` | 実際のスクリプト生成処理 |
| 3-2 | New-DbaScriptingOption | `public/New-DbaScriptingOption.ps1` | ScriptingOptions作成 |
| 3-3 | Get-DbaDbTable | `public/Get-DbaDbTable.ps1` | テーブル取得（InputObject元） |

**主要処理フロー**:
- **Export-DbaScript**: SMOのScript()メソッドを使用してINSERTステートメントを生成

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

```
Export-DbaDbTableData
    │
    ├─ begin
    │      └─ New-DbaScriptingOption
    │             ├─ ScriptSchema = $false
    │             ├─ ScriptData = $true
    │             └─ IncludeDatabaseContext = $true
    │
    └─ process
           └─ Export-DbaScript
                  ├─ PSBoundParameters転送
                  └─ ScriptingOptionsObject設定
                         │
                         └─ SMO Script()
                                │
                                └─ INSERT文生成
```

### データフロー図

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

Get-DbaDbTable ──────────▶ InputObject (Table[])
                                │
                                ▼
                        ┌───────────────────┐
                        │ ScriptingOptions  │
                        │ ScriptData=true   │
                        │ ScriptSchema=false│
                        └───────────────────┘
                                │
                                ▼
                        Export-DbaScript
                                │
Path ───────────────────────────┤
FilePath ───────────────────────┤
Encoding ───────────────────────┤
BatchSeparator ─────────────────┤
NoPrefix ───────────────────────┤
Passthru ───────────────────────┤
NoClobber ──────────────────────┤
Append ─────────────────────────┘
                                │
                                ▼
                        ┌───────────────────┐
                        │ SMO Script()      │
                        │ INSERT文生成      │
                        └───────────────────┘
                                │
            ┌───────────────────┼───────────────────┐
            ▼                   ▼                   ▼
       FileInfo           String[]            (両方)
      (ファイル)        (Passthru)         (同時出力)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Export-DbaDbTableData.ps1 | `public/Export-DbaDbTableData.ps1` | ソース | メイン機能実装 |
| Export-DbaScript.ps1 | `public/Export-DbaScript.ps1` | ソース | スクリプト生成（委譲先） |
| New-DbaScriptingOption.ps1 | `public/New-DbaScriptingOption.ps1` | ソース | ScriptingOptions作成 |
| Get-DbaDbTable.ps1 | `public/Get-DbaDbTable.ps1` | ソース | テーブル取得（InputObject元） |
