# 機能設計書 102-Get-DbaDbExtentDiff

## 概要

本ドキュメントは、最後のフルバックアップ以降に変更されたデータベースエクステントの割合を計算するGet-DbaDbExtentDiff機能の設計仕様を定義する。

### 本機能の処理概要

本機能は、データベースのエクステント（8ページのグループ）を分析し、最後のフルバックアップ以降にどれだけのデータが変更されたかをパーセンテージで算出する。これにより、DBAは差分バックアップとフルバックアップの選択を適切に判断できる。

**業務上の目的・背景**：バックアップ戦略の最適化において、差分バックアップのサイズを事前に予測することは重要である。変更率が高い場合はフルバックアップが効率的であり、変更率が低い場合は差分バックアップがストレージと時間を節約できる。本機能はこの判断材料を提供する。

**機能の利用シーン**：
- バックアップスケジュールの最適化検討
- 差分バックアップサイズの事前予測
- データベース変更パターンの分析
- ストレージ容量計画の策定

**主要な処理内容**：
1. SQL Serverインスタンスへの非プール接続の確立
2. 対象データベースのフィルタリング（アクセス可能なもののみ）
3. SQL Server 2016 SP2以降の場合：sys.dm_db_file_space_usage DMVを使用した効率的な分析
4. 旧バージョンの場合：DBCC PAGEコマンドによる差分ビットマップページの直接検査
5. 変更エクステント数と変更率の計算

**関連システム・外部連携**：SQL Serverのsys.dm_db_file_space_usage DMVまたはDBCC PAGEコマンドを使用。Paul S. Randalの元スクリプトを基にした実装。

**権限による制御**：DBCC PAGEの実行にはsysadmin固定サーバーロールのメンバーシップが必要。DMVアクセスにはVIEW SERVER STATE権限が必要。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | - | - | バックアップ関連画面からの呼び出し（直接の画面関連なし） |

## 機能種別

データ分析処理（計算処理）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstance[] | Yes | 対象のSQL Serverインスタンス | パイプライン入力対応、有効なインスタンス名 |
| SqlCredential | PSCredential | No | 代替認証情報 | Windows/SQL認証、AD統合認証 |
| Database | object[] | No | 対象データベース名 | 存在するデータベース名 |
| ExcludeDatabase | object[] | No | 除外するデータベース名 | 存在するデータベース名 |
| EnableException | switch | No | 例外処理モードの切り替え | - |

### 入力データソース

- SqlInstance: コマンドラインパラメータまたはパイプライン入力
- Database/ExcludeDatabase: コマンドラインパラメータ

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | SQL Serverをホストするコンピュータ名 |
| InstanceName | string | SQL Serverインスタンス名 |
| SqlInstance | string | 完全なSQL Serverインスタンス名 |
| DatabaseName | string | データベース名 |
| ExtentsTotal | int | データベースの総エクステント数 |
| ExtentsChanged | int | 最後のフルバックアップ以降に変更されたエクステント数 |
| ChangedPerc | decimal | 変更されたエクステントの割合（小数点以下2桁） |

### 出力先

PowerShellパイプライン（PSCustomObject）

## 処理フロー

### 処理シーケンス

```
1. 正規表現パターンの初期化（エクステント解析用）
   └─ ':(?<extent>[\d]+)\)' パターンをコンパイル
2. インスタンスごとの処理ループ
   └─ 非プール接続でSQL Serverに接続
3. データベースのフィルタリング
   └─ Database/ExcludeDatabaseパラメータに基づくフィルタリング
   └─ アクセス可能なデータベースのみを対象
4. SQL Serverバージョン判定
   └─ 13.0.5026以上（SQL Server 2016 SP2以上）かどうか
5a. 新バージョンの場合：DMVを使用した分析
   └─ sys.dm_db_file_space_usageから直接取得
5b. 旧バージョンの場合：DBCC PAGEによる分析
   └─ master.sys.master_filesからファイル情報取得
   └─ DBCC PAGEで差分ビットマップを解析
6. 結果の計算と出力
   └─ 変更率を小数点以下2桁に丸めて出力
7. 接続のクローズ
   └─ 非プール接続を明示的に切断
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[正規表現初期化]
    B --> C{インスタンスループ}
    C -->|次のインスタンス| D[非プール接続確立]
    D --> E{接続成功?}
    E -->|No| F[エラー出力]
    F --> C
    E -->|Yes| G[データベースフィルタリング]
    G --> H{バージョン >= 13.0.5026?}
    H -->|Yes| I[DMV使用]
    H -->|No| J[DBCC PAGE使用]
    I --> K[結果出力]
    J --> L[差分ビットマップ解析]
    L --> K
    K --> M[接続切断]
    M --> C
    C -->|完了| N[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-201 | バージョン分岐 | SQL Server 2016 SP2以上ではDMV、それ以外はDBCC PAGE使用 | 常時 |
| BR-202 | アクセシビリティチェック | アクセス不可能なデータベースはスキップ | データベースループ時 |
| BR-203 | 非プール接続 | 接続プールを使用しない専用接続を使用 | 接続時 |

### 計算ロジック

**変更率の計算式**：
- DMV使用時: `100.0 * SUM(modified_extent_page_count) / SUM(total_page_count)`
- DBCC PAGE使用時: `(変更エクステント数 / 総エクステント数) * 100`
- 結果は小数点以下2桁に丸める

**エクステント解析ロジック（Get-DbaExtent関数）**：
- 単一エクステントの場合: カウント+1
- 範囲指定の場合: `(終了ページ - 開始ページ) / 8 + 1`

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

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

| 操作 | 対象テーブル/ビュー | 操作種別 | 概要 |
|-----|-------------|---------|------|
| エクステント情報取得 | sys.dm_db_file_space_usage | SELECT | 変更エクステント情報（2016 SP2以降） |
| ファイル情報取得 | master.sys.master_files | SELECT | データファイル情報（旧バージョン） |
| ページ情報取得 | DBCC PAGE | DBCC | 差分ビットマップページ（旧バージョン） |

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

#### sys.dm_db_file_space_usage（SQL Server 2016 SP2以降）

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| SELECT | total_page_count | 総ページ数 | 8で割ってエクステント数算出 |
| SELECT | modified_extent_page_count | 変更ページ数 | 8で割って変更エクステント数算出 |

#### master.sys.master_files（旧バージョン）

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| SELECT | file_id, size, database_id | type_desc = 'ROWS' | データファイルのみ対象 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| ConnectionError | 接続エラー | SQL Serverへの接続失敗 | Stop-Functionで処理継続 |
| - | 警告 | データベースがアクセス不可 | スキップして次のDBを処理 |

### リトライ仕様

リトライは実装されていない。接続エラー時は次のインスタンスの処理を継続。

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

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

## パフォーマンス要件

- DMV使用時：ミリ秒単位で完了
- DBCC PAGE使用時：データベースサイズに比例（大規模DBでは数分かかる場合あり）

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

- DBCC PAGEの実行にはsysadmin権限が必要
- SqlCredentialパラメータで代替認証情報をサポート
- 非プール接続により、接続の分離を確保

## 備考

- Paul S. Randalの元スクリプトを基にした実装
- 参照: https://www.sqlskills.com/blogs/paul/new-script-how-much-of-the-database-has-changed-since-the-last-full-backup/

---

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

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

### 推奨読解順序

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

出力オブジェクトの構造とヘルパー関数を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Get-DbaDbExtentDiff.ps1 | `public/Get-DbaDbExtentDiff.ps1` | 144-152行目、178-186行目：出力オブジェクト構造 |
| 1-2 | Get-DbaDbExtentDiff.ps1 | `public/Get-DbaDbExtentDiff.ps1` | 89-102行目：Get-DbaExtentヘルパー関数 |

**読解のコツ**: beginブロック内のGet-DbaExtent関数は、DBCC PAGEの出力からエクステント数を計算する内部関数。正規表現で範囲を解析している。

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

パラメータ定義とバージョン分岐ロジックを確認。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Get-DbaDbExtentDiff.ps1 | `public/Get-DbaDbExtentDiff.ps1` | 78-86行目：パラメータ定義 |
| 2-2 | Get-DbaDbExtentDiff.ps1 | `public/Get-DbaDbExtentDiff.ps1` | 134行目：バージョン判定条件 |

**主要処理フロー**:
1. **107-112行目**: 非プール接続でインスタンスに接続
2. **114-131行目**: データベースのフィルタリングとアクセシビリティチェック
3. **134行目**: バージョン判定（13.0.5026 = SQL Server 2016 SP2）
4. **135-153行目**: DMVを使用した新バージョン処理
5. **154-188行目**: DBCC PAGEを使用した旧バージョン処理

#### Step 3: バージョン別処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Get-DbaDbExtentDiff.ps1 | `public/Get-DbaDbExtentDiff.ps1` | 136-142行目：DMVクエリ |
| 3-2 | Get-DbaDbExtentDiff.ps1 | `public/Get-DbaDbExtentDiff.ps1` | 155-176行目：DBCC PAGE処理 |

**主要処理フロー**:
- **136-142行目**: sys.dm_db_file_space_usageからSUMで集計
- **169-174行目**: DBCC PAGEで各差分マップページを走査
- **177行目**: Get-DbaExtent関数で変更エクステント数を計算

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

```
Get-DbaDbExtentDiff
    │
    ├─ Connect-DbaInstance（-NonPooledConnection）
    │
    ├─ Get-DbaExtent（内部関数、旧バージョン用）
    │      └─ 正規表現による範囲解析
    │
    ├─ $server.Query()（DMVクエリ実行）
    │
    └─ Disconnect-DbaInstance（接続切断）
```

### データフロー図

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

                    ┌─────────────────────┐
SqlInstance ───────▶│ Connect-DbaInstance │
                    └──────────┬──────────┘
                               │
Database ──────────────────────┤
                               ▼
                    ┌─────────────────────┐
                    │ バージョン判定      │
                    └──────────┬──────────┘
                               │
                    ┌──────────┴──────────┐
                    ▼                      ▼
            ┌───────────────┐    ┌───────────────┐
            │ DMV使用       │    │ DBCC PAGE     │
            │ (>=2016 SP2)  │    │ (旧バージョン)│
            └───────┬───────┘    └───────┬───────┘
                    │                      │
                    └──────────┬───────────┘
                               ▼
                    ┌─────────────────────┐      ┌─ ComputerName
                    │ PSCustomObject      │──────┼─ ExtentsTotal
                    └─────────────────────┘      ├─ ExtentsChanged
                                                 └─ ChangedPerc
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Get-DbaDbExtentDiff.ps1 | `public/Get-DbaDbExtentDiff.ps1` | ソース | メイン処理 |
| Connect-DbaInstance.ps1 | `public/Connect-DbaInstance.ps1` | ソース | SQL Server接続 |
| Disconnect-DbaInstance.ps1 | `public/Disconnect-DbaInstance.ps1` | ソース | 接続切断 |
