# 機能設計書 629-Export-DbaBinaryFile

## 概要

本ドキュメントは、dbatools PowerShellモジュールの`Export-DbaBinaryFile`コマンドレットに関する機能設計書である。このコマンドレットは、SQL Serverテーブルに格納されたバイナリデータを物理ファイルとして抽出する機能を提供する。

### 本機能の処理概要

**業務上の目的・背景**：SQL Serverのbinary、varbinary、image型カラムに格納されたドキュメント、画像、その他のファイルを、ファイルシステム上の物理ファイルとして取り出す必要がある場面は多い。データベース移行、バックアップ、アーカイブ、外部システムへのファイル提供などで利用される。

**機能の利用シーン**：
- データベースに格納されたドキュメントの一括エクスポート
- 画像や添付ファイルのファイルシステムへの抽出
- データベース移行時のBLOBデータ取り出し
- アーカイブ目的でのファイル出力

**主要な処理内容**：
1. 対象テーブルの特定（直接指定 or Get-DbaDbTable経由）
2. ファイル名カラムとバイナリカラムの自動検出 or 明示指定
3. SQLクエリによるデータ取得
4. ストリーミングによる効率的なファイル書き込み
5. エクスポートされたファイルのFileInfo出力

**関連システム・外部連携**：
- SQL Server Management Objects (SMO)
- ファイルシステム

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

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | CLIコマンド | 主画面 | PowerShellコンソールからの実行 |

## 機能種別

データ抽出 / ファイル出力

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | No | 対象SQL Serverインスタンス | - |
| SqlCredential | PSCredential | No | SQL Server接続用資格情報 | - |
| Database | string[] | No | 対象データベース名 | ワイルドカード可 |
| Table | string[] | No | 対象テーブル名 | 3部構成可、ワイルドカード可 |
| Schema | string[] | No | 対象スキーマ名 | - |
| FileNameColumn | string | No | ファイル名を格納するカラム名（未指定時は自動検出） | - |
| BinaryColumn | string | No | バイナリデータを格納するカラム名（未指定時は自動検出） | - |
| Path | string | 条件付き | 出力ディレクトリ（FilePathとの同時指定不可） | 有効なディレクトリパス |
| FilePath | string | 条件付き | 出力ファイルパス（Pathとの同時指定不可） | 有効なファイルパス |
| Query | string | No | カスタムSQLクエリ（2列必要：filename, binary） | - |
| InputObject | Table[] | No | パイプライン入力用テーブルオブジェクト | - |
| EnableException | switch | No | 例外処理モード切替 | - |

### 入力データソース

- PowerShellコマンドラインからのパラメータ入力
- パイプラインからのGet-DbaDbTable or Get-DbaBinaryFileTable出力

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| FullName | string | エクスポートファイルの完全パス |
| Name | string | ファイル名 |
| DirectoryName | string | ディレクトリパス |
| Directory | DirectoryInfo | 親ディレクトリ情報 |
| Extension | string | ファイル拡張子 |
| Length | long | ファイルサイズ（バイト） |
| CreationTime | DateTime | 作成日時 |
| LastWriteTime | DateTime | 最終更新日時 |
| Attributes | FileAttributes | ファイル属性 |

### 出力先

- ファイルシステム（物理ファイル）
- PowerShellパイプライン（System.IO.FileInfo）

## 処理フロー

### 処理シーケンス

```
1. begin ブロック
   └─ 1.1 Path/FilePath同時指定のチェック
   └─ 1.2 Path/FilePath両方未指定のチェック
   └─ 1.3 Pathディレクトリの存在確認・作成
2. process ブロック（各テーブルごと）
   └─ 2.1 InputObject未指定時はGet-DbaDbTableでテーブル取得
   └─ 2.2 FileNameColumn自動検出（'name'にマッチ）
   └─ 2.3 BinaryColumn自動検出（binary/image型）
   └─ 2.4 SQLクエリ構築
   └─ 2.5 ExecuteReader実行
   └─ 2.6 ストリーミングによるファイル書き込み
         └─ 8192バイトのバッファで読み取り
         └─ BinaryWriterで書き込み
   └─ 2.7 Get-ChildItemで作成ファイルを出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{Path && FilePath?}
    B -->|Yes| C[エラー: 同時指定不可]
    B -->|No| D{!Path && !FilePath?}
    D -->|Yes| E[エラー: どちらか必須]
    D -->|No| F[ディレクトリ作成]
    F --> G[foreach table]
    G --> H{Query指定?}
    H -->|Yes| I[Queryそのまま使用]
    H -->|No| J{FileNameColumn指定?}
    J -->|No| K[自動検出: nameマッチ]
    K --> L{複数/0件?}
    L -->|Yes| M[エラー]
    M --> G
    L -->|No| N{BinaryColumn指定?}
    J -->|Yes| N
    N -->|No| O[自動検出: binary/image型]
    O --> P{複数/0件?}
    P -->|Yes| Q[エラー]
    Q --> G
    P -->|No| R[クエリ構築]
    N -->|Yes| R
    I --> R
    R --> S[ExecuteReader]
    S --> T[while reader.Read]
    T --> U[ファイルパス決定]
    U --> V[ShouldProcess確認]
    V --> W[BinaryWriterで書き込み]
    W --> X[Get-ChildItem出力]
    X --> T
    T --> G
    G --> Y[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | 出力パス排他 | PathとFilePathは同時指定不可 | 常時 |
| BR-002 | 出力パス必須 | PathまたはFilePathのどちらかは必須 | 常時 |
| BR-003 | FileNameColumn自動検出 | カラム名に'name'を含むカラムを検索 | FileNameColumn未指定時 |
| BR-004 | BinaryColumn自動検出 | binary/image型のカラムを検索 | BinaryColumn未指定時 |
| BR-005 | 一意性要件 | 自動検出時、複数マッチはエラー | 自動検出時 |
| BR-006 | ストリーミング | 8192バイトバッファでメモリ効率的に処理 | 常時 |

### 計算ロジック

- バッファサイズ: 8192バイト
- ファイルパス決定: Path指定時は元ファイル名を使用、FilePath指定時はそのパスを使用

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| データ取得 | 指定テーブル | SELECT | バイナリデータとファイル名取得 |

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

#### 対象テーブル

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| SELECT | FileNameColumn | ファイル名取得 | 出力ファイル名に使用 |
| SELECT | BinaryColumn | バイナリデータ取得 | ファイルコンテンツ |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | Stop-Function | Path/FilePath同時指定 | どちらか一方のみ指定 |
| - | Stop-Function | Path/FilePath両方未指定 | どちらかを指定 |
| - | Stop-Function | FileNameColumn複数マッチ | FileNameColumnを明示指定 |
| - | Stop-Function | FileNameColumn 0件 | FileNameColumnを明示指定 |
| - | Stop-Function | BinaryColumn複数マッチ | BinaryColumnを明示指定 |
| - | Stop-Function | BinaryColumn 0件 | BinaryColumnを明示指定 |
| - | Stop-Function | エクスポート失敗 | テーブル名、権限を確認 |

### リトライ仕様

リトライ機能なし

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

読み取り専用（SELECT）のため、トランザクション管理は不要。

## パフォーマンス要件

- ストリーミング処理により大容量ファイルも効率的に処理
- バッファサイズ8192バイトでメモリ使用量を抑制
- 多数のファイル処理時はI/Oがボトルネックになる可能性

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

- 対象テーブルへのSELECT権限が必要
- 出力先ディレクトリへの書き込み権限が必要
- 機密ファイルの出力には注意

## 備考

- Get-DbaBinaryFileTableとの連携でインタラクティブなテーブル選択が可能
- Out-GridView -PassThruとの組み合わせが有効
- Queryパラメータでカスタム抽出条件を指定可能

---

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

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

### 推奨読解順序

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

出力のFileInfoオブジェクトと、入力のテーブル構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Export-DbaBinaryFile.ps1 | `public/Export-DbaBinaryFile.ps1` | .OUTPUTS セクション - System.IO.FileInfo |

**読解のコツ**: 出力は標準の.NET FileInfoオブジェクト。ファイルシステムに実ファイルが作成される。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Export-DbaBinaryFile.ps1 | `public/Export-DbaBinaryFile.ps1` | パラメータ定義とbeginブロック |

**主要処理フロー**:
1. **127-143行目**: パラメータ定義
2. **144-158行目**: beginブロック - パス検証とディレクトリ作成
3. **159-264行目**: processブロック - メイン処理

#### Step 3: 各処理層を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Export-DbaBinaryFile.ps1 | `public/Export-DbaBinaryFile.ps1` | カラム自動検出とストリーミング書き込み |

**主要処理フロー**:
- **161-168行目**: InputObject取得（Get-DbaDbTable）
- **180-187行目**: FileNameColumn自動検出
- **190-197行目**: BinaryColumn自動検出
- **202行目**: バッファサイズ8192設定
- **211-212行目**: ExecuteReader実行
- **215行目**: バイト配列初期化
- **218-237行目**: ストリーミング書き込みループ
- **244行目**: Get-ChildItemでFileInfo出力

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

```
Export-DbaBinaryFile
    │
    ├─ [begin] パス検証
    │      └─ New-Item (ディレクトリ作成)
    │
    ├─ Get-DbaDbTable (テーブル取得)
    │      └─ InputObject未指定時
    │
    ├─ カラム自動検出
    │      ├─ FileNameColumn (nameマッチ)
    │      └─ BinaryColumn (binary/image型)
    │
    ├─ ExecuteReader (SQLクエリ実行)
    │
    ├─ ストリーミング書き込み
    │      ├─ FileStream
    │      ├─ BinaryWriter
    │      └─ reader.GetBytes()
    │
    └─ Get-ChildItem (FileInfo出力)
```

### データフロー図

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

SqlInstance/Table ──────▶ Get-DbaDbTable ────────────▶ Table object
                                │
FileNameColumn/BinaryColumn ────▶ カラム検出
(自動 or 指定)                  │
                                ▼
                          Query構築
                          "SELECT [fname], [data] FROM..."
                                │
                                ▼
Path/FilePath ──────────▶ ExecuteReader
                          ストリーミング読み取り
                                │
                                ▼
                          BinaryWriter ──────────────▶ 物理ファイル
                          (8192バイトバッファ)
                                │
                                ▼
                          Get-ChildItem ─────────────▶ FileInfo
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Export-DbaBinaryFile.ps1 | `public/Export-DbaBinaryFile.ps1` | ソース | メインコマンドレット |
| Get-DbaDbTable.ps1 | `public/Get-DbaDbTable.ps1` | ソース | テーブルオブジェクト取得 |
| Get-DbaBinaryFileTable.ps1 | `public/Get-DbaBinaryFileTable.ps1` | ソース | バイナリファイルテーブル検出 |
| Import-DbaBinaryFile.ps1 | `public/Import-DbaBinaryFile.ps1` | ソース | バイナリファイルインポート（対機能） |
