# 機能設計書 645-Measure-DbaDiskSpaceRequirement

## 概要

本ドキュメントは、SQL Serverインスタンス間でのデータベース移行に必要なディスク容量を計算するdbatools PowerShellコマンド「Measure-DbaDiskSpaceRequirement」の機能設計書です。

### 本機能の処理概要

Measure-DbaDiskSpaceRequirementは、ソースインスタンスと宛先インスタンス間でデータベースファイルを比較し、移行に必要なディスク容量を計算するコマンドです。

**業務上の目的・背景**：データベース移行プロジェクトでは、宛先サーバーのディスク容量が十分かどうかを事前に確認することが重要です。容量不足による移行失敗は、ダウンタイムの延長やプロジェクト遅延を引き起こします。本機能により、移行前にファイルサイズの差分を把握し、必要なストレージ容量を正確に見積もることができます。

**機能の利用シーン**：
- データベース移行プロジェクトの事前計画
- サーバー統合時の容量見積もり
- DR（災害復旧）サイトへの移行準備
- データベースコピー前の容量確認
- 一括移行計画のためのストレージ要件収集

**主要な処理内容**：
1. ソースSQL Serverインスタンスへの接続とデータベースファイル情報取得
2. 宛先SQL Serverインスタンスへの接続と既存ファイル情報取得
3. ファイル名によるマッチングと差分計算
4. マウントポイント情報の取得と関連付け
5. 3つのシナリオ（両方に存在、ソースのみ、宛先のみ）での結果出力

**関連システム・外部連携**：
- ソースSQL Serverインスタンス
- 宛先SQL Serverインスタンス
- Windows Management Instrumentation（マウントポイント取得）

**権限による制御**：両方のSQL Serverインスタンスに対するデータベース参照権限、およびWMIアクセス用の資格情報が必要です。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | CLI専用 | 主機能 | コマンドライン実行のみ |

## 機能種別

分析・計算 / 移行計画支援

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| Source | DbaInstanceParameter | Yes | ソースSQL Serverインスタンス | パイプライン対応 |
| SourceSqlCredential | PSCredential | No | ソースSQL Server接続用資格情報 | パイプライン対応 |
| Database | string | Yes | 対象データベース名 | パイプライン対応 |
| Destination | DbaInstanceParameter | Yes | 宛先SQL Serverインスタンス | パイプライン対応 |
| DestinationSqlCredential | PSCredential | No | 宛先SQL Server接続用資格情報 | パイプライン対応 |
| DestinationDatabase | string | No | 宛先データベース名（異なる場合） | パイプライン対応 |
| Credential | PSCredential | No | CIM/WMI接続用資格情報 | パイプライン対応 |
| EnableException | switch | No | エラー時に例外をスロー | - |

### 入力データソース

- パイプライン入力: Source, Database, Destination等のプロパティを持つオブジェクト
- CSVファイル: Tab区切りでSource, Destination, Database, DestinationDatabaseヘッダー
- SQLテーブル: Invoke-DbaCmdからのパイプライン入力

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 | 表示 |
|--------|-----|------|------|
| SourceComputerName | string | ソースのコンピュータ名 | 非表示 |
| SourceInstance | string | ソースのインスタンス名 | 非表示 |
| SourceSqlInstance | string | ソースの完全なインスタンス名 | デフォルト |
| SourceDatabase | string | ソースデータベース名 | デフォルト |
| SourceLogicalName | string | ソースファイルの論理名 | デフォルト |
| SourceFileName | string | ソースファイルの物理パス | デフォルト |
| SourceFileSize | DbaSize | ソースファイルサイズ | デフォルト |
| DestinationComputerName | string | 宛先のコンピュータ名 | デフォルト |
| DestinationInstance | string | 宛先のインスタンス名 | 非表示 |
| DestinationSqlInstance | string | 宛先の完全なインスタンス名 | デフォルト |
| DestinationDatabase | string | 宛先データベース名 | デフォルト |
| DestinationLogicalName | string | 宛先ファイルの論理名 | 非表示 |
| DestinationFileName | string | 宛先ファイルの物理パス | デフォルト |
| DestinationFileSize | DbaSize | 宛先ファイルサイズ（負値で表示） | デフォルト |
| DifferenceSize | DbaSize | ファイルサイズ差分 | デフォルト |
| MountPoint | string | 宛先ボリュームマウントポイント | デフォルト |
| FileLocation | string | ファイル位置（"Source and Destination"/"Only on Source"/"Only on Destination"） | デフォルト |

### 出力先

パイプライン出力（PSCustomObject、Select-DefaultViewでデフォルト表示制御）

## 処理フロー

### 処理シーケンス

```
1. ソースSQL Serverへの接続
   └─ Connect-DbaInstanceで接続確立

2. 宛先SQL Serverへの接続
   └─ Connect-DbaInstanceで接続確立

3. ソースデータベースファイル情報取得
   ├─ FileGroups.Files（データファイル）
   └─ LogFiles（ログファイル）

4. 宛先データベースファイル情報取得（存在する場合）
   ├─ FileGroups.Files（データファイル）
   └─ LogFiles（ログファイル）

5. ファイル比較とマウントポイント取得
   ├─ 両方に存在するファイル: 差分計算
   ├─ ソースのみのファイル: デフォルトパスのマウントポイント取得
   └─ 宛先のみのファイル: 上書き時の削減量として出力

6. 結果オブジェクト出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[Connect-DbaInstance Source]
    B --> C{接続成功?}
    C -->|No| D[Stop-Function]
    C -->|Yes| E[Connect-DbaInstance Destination]
    E --> F{接続成功?}
    F -->|No| D
    F -->|Yes| G[Get-DbaDatabase Source]
    G --> H[ソースファイル情報取得]
    H --> I{宛先DB存在?}
    I -->|Yes| J[宛先ファイル情報取得]
    I -->|No| K[宛先ファイルなし]
    J --> L[ファイル比較ループ]
    K --> L
    L --> M{ファイル一致?}
    M -->|Yes| N[Source and Destination出力]
    M -->|No| O{ソースのみ?}
    O -->|Yes| P[Only on Source出力]
    O -->|No| Q[Only on Destination出力]
    N --> R{次ファイル?}
    P --> R
    Q --> R
    R -->|Yes| L
    R -->|No| S[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | DestinationDatabaseデフォルト | 未指定時はソースと同じDB名を使用 | DestinationDatabase未指定時 |
| BR-002 | ファイルマッチング | 論理名（Name）でソースと宛先をマッチング | 常時 |
| BR-003 | サイズ計算 | ソースサイズ - 宛先サイズ = DifferenceSize | 常時 |
| BR-004 | 宛先サイズ負値表示 | 宛先ファイルサイズは負値で表示（上書き時の削減効果を示す） | 常時 |
| BR-005 | マウントポイントキャッシュ | コンピュータごとにマウントポイント情報をキャッシュ | パフォーマンス最適化 |

### 計算ロジック

- SourceFileSize = Size * 1000（KB→バイト変換）
- DestinationFileSize = Size * 1000 * -1（負値）
- DifferenceSize = (SourceSize * 1000) - (DestSize * 1000)

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

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

本機能はデータベースに対する変更操作を行いません。ファイル情報の読み取りのみを実行します。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ConnectionError | ソースSQL Server接続失敗 | 接続情報を確認 |
| - | ConnectionError | 宛先SQL Server接続失敗 | 接続情報を確認 |
| - | DatabaseNotFound | ソースデータベースが存在しない | データベース名を確認 |
| - | WmiError | マウントポイント取得失敗 | Credential確認、WMIアクセス権限確認 |

### リトライ仕様

マウントポイント取得失敗時は "?" を設定して処理続行

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

該当なし（読み取り専用操作）

## パフォーマンス要件

- マウントポイント情報はキャッシュ（$local:cacheMP, $local:cacheDP）
- 大量のデータベース移行計画時はパイプライン入力を推奨

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

- 両方のSQL Serverインスタンスに対する接続権限が必要
- WMI/CIMアクセス用のCredentialパラメータをサポート

## 備考

- パイプライン入力で一括処理が可能（CSV, SQL, PSCustomObject）
- DbaSize型により自動的にKB/MB/GB/TB単位で表示

---

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

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

### 推奨読解順序

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

出力オブジェクトとDbaSize型の関係を理解します。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Measure-DbaDiskSpaceRequirement.ps1 | `public/Measure-DbaDiskSpaceRequirement.ps1` | L267-285, L291-310, L317-335の3つの出力パターン |

**読解のコツ**: FileLocationプロパティにより3つのシナリオ（"Source and Destination", "Only on Source", "Only on Destination"）を区別できます。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Measure-DbaDiskSpaceRequirement.ps1 | `public/Measure-DbaDiskSpaceRequirement.ps1` | beginとprocessブロック |

**主要処理フロー**:
1. **136-138行目**: キャッシュ変数初期化
2. **139-225行目**: ヘルパー関数定義（Get-MountPoint, Get-MountPointFromPath, Get-MountPointFromDefaultPath）
3. **227-240行目**: ソース/宛先への接続
4. **247-261行目**: ファイル情報取得
5. **263-337行目**: ファイル比較と結果出力

#### Step 3: マウントポイント取得ロジックを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Measure-DbaDiskSpaceRequirement.ps1 | `public/Measure-DbaDiskSpaceRequirement.ps1` | L139-225のヘルパー関数 |

**主要処理フロー**:
- **139-147行目**: Get-MountPoint - WMI Win32_MountPointクラスからマウントポイント取得
- **148-176行目**: Get-MountPointFromPath - パスからマウントポイントを逆引き（キャッシュ対応）
- **177-225行目**: Get-MountPointFromDefaultPath - デフォルトパス（Log/Data）からマウントポイント取得

#### Step 4: ファイル比較ロジックを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | Measure-DbaDiskSpaceRequirement.ps1 | `public/Measure-DbaDiskSpaceRequirement.ps1` | L263-337のファイル比較 |

**主要処理フロー**:
- **263-287行目**: 両方に存在するファイル処理
- **289-311行目**: ソースのみのファイル処理
- **313-337行目**: 宛先のみのファイル処理（Compare-Object使用）

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

```
Measure-DbaDiskSpaceRequirement
    │
    ├─ Connect-DbaInstance（ソース）
    │
    ├─ Connect-DbaInstance（宛先）
    │
    ├─ Get-DbaDatabase（ソース/宛先）
    │
    ├─ Get-MountPoint
    │      └─ Get-DbaCmObject（Win32_MountPoint）
    │
    ├─ Get-MountPointFromPath（キャッシュ対応）
    │      └─ Get-MountPoint
    │
    ├─ Get-MountPointFromDefaultPath
    │      ├─ Get-DbaDefaultPath
    │      └─ Get-MountPoint
    │
    └─ Compare-Object（宛先のみファイル検出）
```

### データフロー図

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

Source ────────────────┐
                       │
SourceSqlCredential ───┤
                       │
Database ──────────────┼──▶ ファイル情報取得 ────────┐
                       │         │                   │
Destination ───────────┤         ▼                   ▼
                       │    ファイル比較          PSCustomObject
DestinationSqlCred ────┤         │                (Source*,
                       │         ▼                 Destination*,
DestinationDatabase ───┤    マウントポイント取得    DifferenceSize,
                       │         │                 MountPoint,
Credential ────────────┘         ▼                 FileLocation)
                            3パターン出力
                            ├─ Source and Destination
                            ├─ Only on Source
                            └─ Only on Destination
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Measure-DbaDiskSpaceRequirement.ps1 | `public/Measure-DbaDiskSpaceRequirement.ps1` | ソース | メインコマンド実装 |
| Get-DbaDatabase.ps1 | `public/Get-DbaDatabase.ps1` | ソース | データベースオブジェクト取得 |
| Get-DbaDefaultPath.ps1 | `public/Get-DbaDefaultPath.ps1` | ソース | デフォルトパス取得 |
| Get-DbaCmObject.ps1 | `public/Get-DbaCmObject.ps1` | ソース | WMI/CIMクエリ実行 |
| Connect-DbaInstance.ps1 | `public/Connect-DbaInstance.ps1` | ソース | SQL Server接続 |
