# 機能設計書 639-Get-DbaFile

## 概要

本ドキュメントは、dbatools PowerShellモジュールのGet-DbaFileコマンドレットの機能設計書である。このコマンドは、xp_dirtreeを使用してリモートSQL Serverインスタンス上のファイルとディレクトリを列挙し、直接ファイルシステムアクセスやRDP接続なしにファイル一覧を取得する。

### 本機能の処理概要

Get-DbaFileは、SQL Serverマシン上のディレクトリを、直接ファイルシステムアクセスやRDP接続を必要とせずにリモートで検索する。xp_dirtree拡張ストアドプロシージャを使用してファイル一覧を返し、拡張子でフィルタリングしたり、指定した深さまで再帰的に検索したりできる。デフォルトではインスタンスのデータディレクトリが返され、-Pathパラメータで追加の検索パスを指定できる。

**業務上の目的・背景**：DBAは、リモートSQL Serverマシン上のファイルを調査する必要があることが多い。しかし、ファイルサーバーへの直接アクセスが制限されていたり、RDP接続が許可されていない環境もある。このコマンドは、SQL Serverのxp_dirtreeを使用することで、SQL Server認証さえあればファイルシステムの調査が可能になる。

**機能の利用シーン**：
- 孤立したデータベースファイル（MDF/NDF/LDF）の発見
- リストア用のバックアップファイルの検索
- ディスク使用量の監査
- ファイル移行の準備
- トラブルシューティング時のファイル存在確認

**主要な処理内容**：
1. 指定されたSQL Serverインスタンスに接続
2. Pathが指定されていない場合、デフォルトデータディレクトリを使用
3. xp_dirtreeを使用してディレクトリツリーを取得
4. 一時テーブルを使用して階層構造を解析
5. 拡張子でフィルタリング（FileType指定時）
6. 結果をPSCustomObjectとして出力

**関連システム・外部連携**：Get-DbaDefaultPath（デフォルトパス取得）、Restore-DbaDatabase（バックアップファイル検索後のリストア）と連携

**権限による制御**：xp_dirtree実行権限が必要（通常sysadmin、またはxp_dirtreeへのEXECUTE権限）

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | コマンドライン/PowerShellコンソール | 主画面 | コマンド実行および結果表示 |

## 機能種別

データ取得 / ファイルシステム探索

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | Yes | 対象SQL Serverインスタンス。必須、複数指定可、パイプライン入力対応 | なし |
| SqlCredential | PSCredential | No | 代替認証情報 | Windows認証、SQL認証、AD認証対応 |
| Path | string[] | No | 検索対象ディレクトリパス。デフォルトはデータディレクトリ | なし |
| FileType | string[] | No | フィルタ対象の拡張子（ドットなし、例：'mdf', 'bak'） | なし |
| Depth | int | No | 再帰検索の深さ。デフォルトは1（現在のディレクトリのみ） | なし |
| EnableException | switch | No | 例外を有効にして詳細なエラー情報を取得 | なし |

### 入力データソース

- xp_dirtreeストアドプロシージャ経由でSQL Serverからファイル情報を取得
- Path未指定時はGet-DbaDefaultPathでデフォルトデータディレクトリを取得

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | String | SQL Serverインスタンスのコンピュータ名 |
| InstanceName | String | SQL Serverインスタンス名 |
| SqlInstance | String | 完全なSQL Serverインスタンス名 |
| Filename | String | ファイルのフルパス |
| RemoteFilename | String | リモートアクセス用のUNCパス |

### 出力先

PowerShellパイプライン（PSCustomObject）

## 処理フロー

### 処理シーケンス

```
1. 初期化（beginブロック）
   └─ Get-SQLDirTreeQuery関数を定義
   └─ Format-Path関数を定義
   └─ FileTypeを小文字に正規化

2. インスタンスごとの処理ループ
   └─ Connect-DbaInstanceで接続
   └─ 接続失敗時はStop-Function -Continue

3. パス設定
   └─ Path未指定時：Get-DbaDefaultPathでデータディレクトリ取得
   └─ Linux/Windowsのパス区切り文字を判定

4. SQLクエリ生成
   └─ Get-SQLDirTreeQuery関数でxp_dirtree用クエリを生成
   └─ 一時テーブル作成とxp_dirtree実行を組み合わせ

5. クエリ実行
   └─ ExecuteWithResultsでSQLを実行
   └─ 結果をdatatableに格納

6. 結果処理
   └─ FileType指定時：拡張子でフィルタリング
   └─ パス区切り文字を正規化
   └─ UNCパスを生成（Join-AdminUnc使用）

7. 出力
   └─ PSCustomObjectとしてパイプラインに出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[関数定義・初期化]
    B --> C[インスタンスループ]
    C --> D[Connect-DbaInstance]
    D --> E{接続成功?}
    E -->|No| F[Stop-Function -Continue]
    E -->|Yes| G{Path指定?}
    F --> C2{次のインスタンス?}
    G -->|No| H[Get-DbaDefaultPath]
    G -->|Yes| I[指定パス使用]
    H --> I
    I --> J[OS判定]
    J --> K[Get-SQLDirTreeQuery]
    K --> L[ExecuteWithResults]
    L --> M{FileType指定?}
    M -->|Yes| N[拡張子フィルタ]
    M -->|No| O[結果ループ]
    N --> O
    O --> P[パス正規化]
    P --> Q[PSCustomObject出力]
    Q --> R{次の結果?}
    R -->|Yes| O
    R -->|No| C2
    C2 -->|Yes| C
    C2 -->|No| S[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | デフォルトパス | Path未指定時はインスタンスのデータディレクトリを使用 | Path未指定時 |
| BR-002 | 深さ制限 | Depthパラメータで再帰検索の深さを制限（デフォルト1） | 常時 |
| BR-003 | 拡張子フィルタ | FileTypeはドットなしで指定、大文字小文字を区別しない | FileType指定時 |
| BR-004 | RECYCLE.BIN除外 | クエリ内でRECYCLE.BINを含むパスを除外 | 常時 |
| BR-005 | パス区切り正規化 | Linux（/）とWindows（\）のパス区切りを適切に処理 | 常時 |

### 計算ロジック

Get-SQLDirTreeQuery関数内でのSQL生成：
- 一時テーブル#DirectoryTreeを作成
- xp_dirtreeで指定深さまで再帰取得
- 親ディレクトリIDを計算してフルパスを構築
- WITH DIRS CTEで階層パスを連結

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

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

| 操作 | 対象 | 操作種別 | 概要 |
|-----|------|---------|------|
| ディレクトリ列挙 | xp_dirtree | EXEC | ディレクトリツリー取得 |
| 一時テーブル作成 | #DirectoryTree | CREATE/INSERT | ファイル情報格納 |
| 一時テーブル削除 | #DirectoryTree | DROP | クリーンアップ |

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

#### #DirectoryTree（一時テーブル）

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| CREATE | id, subdirectory, depth, isfile, ParentDirectory, flag | - | 一時テーブル作成 |
| INSERT | 全カラム | xp_dirtreeの結果 | ディレクトリツリー格納 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ConnectionError | SQL Serverへの接続失敗 | Stop-Function -Continueで次のインスタンスへ |

### リトライ仕様

リトライ機能なし。接続エラー時は当該インスタンスをスキップして次を処理。

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

一時テーブル操作のみで、明示的なトランザクション管理は不要。

## パフォーマンス要件

- xp_dirtreeはファイル数が多いと時間がかかる
- Depthを大きくすると処理時間が増加
- 大量のファイルがある場合、メモリ使用量に注意

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

- xp_dirtree実行権限が必要
- SQL Serverサービスアカウントがアクセス可能なパスのみ列挙可能
- SqlCredentialパラメータでSQL認証、Windows認証、AD認証をサポート

## 備考

- 参照: https://www.sqlservercentral.com/Forums/Topic1642213-391-1.aspx（serg-52のクエリ）
- SMBシェアパス（\\で始まる）もサポート
- 特殊文字を含むパスは__に置換される
- Join-AdminUncでリモートアクセス用のUNCパスを生成

---

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

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

### 推奨読解順序

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

xp_dirtreeの出力とSQL生成ロジックを理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Get-DbaFile.ps1 | `public/Get-DbaFile.ps1` | 106-170行目のGet-SQLDirTreeQuery関数 |
| 1-2 | Get-DbaFile.ps1 | `public/Get-DbaFile.ps1` | 118-124行目の一時テーブル構造 |

**読解のコツ**: xp_dirtreeは（subdirectory, depth, isfile）を返す。このコードはParentDirectoryを計算して階層パスを構築している。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Get-DbaFile.ps1 | `public/Get-DbaFile.ps1` | 185-191行目のprocessブロック開始部分 |

**主要処理フロー**:
1. **187-191行目**: Connect-DbaInstanceで接続
2. **194-195行目**: Path未指定時のデフォルトパス取得

#### Step 3: OS判定とクエリ実行を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Get-DbaFile.ps1 | `public/Get-DbaFile.ps1` | 196-208行目のOS判定とクエリ実行 |

**主要処理フロー**:
- **196-200行目**: Test-HostOSLinuxでパス区切り文字を判定
- **204行目**: Get-SQLDirTreeQuery呼び出し
- **208行目**: ExecuteWithResultsでSQL実行

#### Step 4: 結果処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | Get-DbaFile.ps1 | `public/Get-DbaFile.ps1` | 211-249行目の結果処理 |

**主要処理フロー**:
- **211-234行目**: FileType指定時のフィルタリングと出力
- **235-248行目**: FileType未指定時の全件出力

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

```
Get-DbaFile
    │
    ├─ Connect-DbaInstance
    │      └─ SQL Server接続確立
    │
    ├─ Get-DbaDefaultPath（Path未指定時）
    │      └─ デフォルトデータディレクトリ取得
    │
    ├─ Test-HostOSLinux
    │      └─ OS判定
    │
    ├─ Get-SQLDirTreeQuery（内部関数）
    │      └─ xp_dirtree用SQLクエリ生成
    │
    ├─ ExecuteWithResults
    │      └─ SQLクエリ実行
    │
    └─ Join-AdminUnc
           └─ UNCパス生成
```

### データフロー図

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

SqlInstance/Path      ───▶ Connect-DbaInstance
                                 │
                                 ▼
                           Get-DbaDefaultPath
                           (Path未指定時)
                                 │
                                 ▼
                           Get-SQLDirTreeQuery
                           (xp_dirtreeクエリ生成)
                                 │
                                 ▼
                           ExecuteWithResults
                                 │
                                 ▼
                           フィルタリング            ───▶ PSCustomObject
                           (FileType)                    - Filename
                           パス正規化                    - RemoteFilename
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Get-DbaFile.ps1 | `public/Get-DbaFile.ps1` | ソース | メイン処理ロジック |
| Get-DbaDefaultPath.ps1 | `public/Get-DbaDefaultPath.ps1` | ソース | 内部依存（デフォルトパス取得） |
| Connect-DbaInstance.ps1 | `public/Connect-DbaInstance.ps1` | ソース | 内部依存（インスタンス接続） |
| Join-AdminUnc.ps1 | `functions/Join-AdminUnc.ps1` | ソース | 内部依存（UNCパス生成） |
