# 機能設計書 41-Measure-DbaBackupThroughput

## 概要

本ドキュメントは、SQL Serverのバックアップ履歴からスループット統計を計算し、バックアップパフォーマンスを分析するdbatools PowerShellコマンド `Measure-DbaBackupThroughput` の機能設計書である。

### 本機能の処理概要

この機能は、msdbデータベースに記録されたバックアップ履歴を分析し、バックアップ操作のスループット統計（平均、最小、最大のバックアップ速度をMB/秒単位）を計算する。

**業務上の目的・背景**：データベース管理者（DBA）がバックアップのパフォーマンスを把握し、ボトルネックの特定、バックアップ戦略の最適化、キャパシティプランニングを行うために必要な機能である。RTO（目標復旧時間）要件を満たすバックアップウィンドウの確保が求められる環境において、過去のバックアップパフォーマンスデータは重要な指標となる。

**機能の利用シーン**：
- バックアップの定期的なパフォーマンス監視
- ストレージシステムの変更前後のパフォーマンス比較
- 遅いバックアップの原因調査
- バックアップ計画の最適化のための基礎データ収集
- SLA遵守状況の確認

**主要な処理内容**：
1. 指定されたSQL Serverインスタンスへの接続
2. 対象データベースの特定（フィルタリング）
3. Get-DbaDbBackupHistoryを使用したバックアップ履歴の取得
4. 各バックアップのスループット計算（サイズ / 所要時間）
5. データベースごとの統計値（平均、最小、最大）の集計
6. 結果オブジェクトの出力

**関連システム・外部連携**：msdbデータベースのバックアップ履歴テーブル（backupset等）から情報を取得する。Get-DbaDbBackupHistoryコマンドに依存している。

**権限による制御**：msdbデータベースの参照権限が必要。通常、sysadmin、db_owner（msdb）、または特定のバックアップ履歴ビューへのアクセス権限が必要である。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 19 | データベースバックアップ | 補助機能 | バックアップスループットの測定 |

## 機能種別

計算処理 / データ分析

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | Yes | 対象SQL Serverインスタンス | 有効なインスタンス名であること |
| SqlCredential | PSCredential | No | 代替認証情報 | - |
| Database | object[] | No | 分析対象データベース名。ワイルドカード対応 | - |
| ExcludeDatabase | object[] | No | 除外するデータベース名。ワイルドカード対応 | - |
| Since | datetime | No | この日時以降のバックアップのみを分析 | 有効な日時形式 |
| Last | switch | No | 各データベースの最新バックアップのみを分析 | - |
| Type | string | No | バックアップ種別（Full/Log/Differential等）。デフォルト: Full | ValidateSet検証 |
| DeviceType | string[] | No | バックアップデバイス種別（Disk/Tape等） | - |
| EnableException | switch | No | 例外を有効にするスイッチ | - |

### 入力データソース

msdbデータベースのbackupset、backupmediafamily等のシステムテーブル（Get-DbaDbBackupHistory経由）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | SQL Serverのコンピュータ名 |
| InstanceName | string | SQL Serverインスタンス名 |
| SqlInstance | string | 完全なSQL Serverインスタンス名 |
| Database | string | 分析対象データベース名 |
| AvgThroughput | DbaSize | 平均バックアップスループット（MB/秒） |
| AvgSize | DbaSize | 平均バックアップサイズ |
| AvgDuration | DbaTimeSpan | 平均バックアップ所要時間 |
| MinThroughput | DbaSize | 最小バックアップスループット |
| MaxThroughput | DbaSize | 最大バックアップスループット |
| MinBackupDate | DbaDateTime | 分析期間内の最古バックアップ日時 |
| MaxBackupDate | DbaDateTime | 分析期間内の最新バックアップ日時 |
| BackupCount | int | 分析対象バックアップ数 |

### 出力先

PowerShellパイプライン（PSCustomObject）

## 処理フロー

### 処理シーケンス

```
1. パラメータ検証と初期化
   └─ ValueFromPipelineによる複数インスタンス対応
2. 各SqlInstanceに対してループ処理
   └─ Connect-DbaInstanceでの接続確立
3. 対象データベースの特定
   └─ Database/ExcludeDatabase パラメータによるフィルタリング
4. 各データベースのバックアップ履歴取得
   └─ Get-DbaDbBackupHistory呼び出し（Since/Last/DeviceType/Type指定）
5. スループット計算
   └─ 各バックアップの TotalSize / Duration を計算
6. 統計集計
   └─ データベースごとに平均、最小、最大を算出
7. 結果オブジェクト生成と出力
   └─ PSCustomObjectをパイプラインに出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[パラメータ受取]
    B --> C{SqlInstanceループ}
    C --> D[Connect-DbaInstance]
    D --> E{接続成功?}
    E -->|No| F[Stop-Function]
    F --> C
    E -->|Yes| G[データベース一覧取得]
    G --> H{Database指定あり?}
    H -->|Yes| I[フィルタリング適用]
    H -->|No| I
    I --> J{ExcludeDatabase指定?}
    J -->|Yes| K[除外フィルタ適用]
    J -->|No| L[データベースループ]
    K --> L
    L --> M[Get-DbaDbBackupHistory]
    M --> N{履歴あり?}
    N -->|No| L
    N -->|Yes| O[スループット計算]
    O --> P[Add-Member MBps追加]
    P --> Q[データベースグループ化]
    Q --> R[統計値計算]
    R --> S[PSCustomObject出力]
    S --> L
    L --> C
    C --> T[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-41-01 | スループット計算 | スループット = バックアップサイズ(MB) / 所要時間(秒) | 所要時間が0より大きい場合 |
| BR-41-02 | ゼロ時間バックアップ | 所要時間が0の場合、スループット = バックアップサイズ(MB) | 所要時間が0の場合 |
| BR-41-03 | デフォルトバックアップタイプ | Type未指定時はFullバックアップを対象とする | Typeパラメータ未指定時 |

### 計算ロジック

**スループット計算（173-179行目）**:
```powershell
$timeTaken = New-TimeSpan -Start $history.Start -End $history.End
if ($timeTaken.TotalMilliseconds -eq 0) {
    $throughput = $history.TotalSize.Megabyte
} else {
    $throughput = $history.TotalSize.Megabyte / $timeTaken.TotalSeconds
}
```

**平均スループット計算（200行目）**:
```powershell
AvgThroughput = [DbaSize]([System.Math]::Round($measureMb.Average, 2) * 1024 * 1024)
```

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| バックアップ履歴取得 | msdb.dbo.backupset | SELECT | バックアップセット情報の取得 |
| バックアップ履歴取得 | msdb.dbo.backupmediafamily | SELECT | バックアップメディア情報の取得 |

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

#### msdb.dbo.backupset

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| SELECT | backup_start_date, backup_finish_date | Type、Database条件に一致 | Get-DbaDbBackupHistory経由 |
| SELECT | backup_size, compressed_backup_size | 上記と同一条件 | サイズ情報取得 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| ConnectionError | 接続エラー | SQL Serverへの接続失敗 | Stop-Functionでスキップし次のインスタンスへ継続 |
| - | データなし | バックアップ履歴が存在しない | 警告なしでスキップ |

### リトライ仕様

本機能にはリトライ機構は実装されていない。

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

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

## パフォーマンス要件

- 大量のバックアップ履歴がある場合、Since パラメータで期間を限定することを推奨
- Last パラメータ使用で最新バックアップのみに限定し、処理時間を短縮可能

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

- msdbデータベースへの参照権限が必要
- SqlCredentialパラメータでセキュアな認証情報の受け渡しが可能
- Windows認証、SQL Server認証、Active Directory認証に対応

## 備考

- DbaSize、DbaTimeSpan、DbaDateTimeはdbatools独自の型で、自動的に適切な単位（Bytes/KB/MB/GB/TB）でフォーマットされる
- Type パラメータの有効値: "Full", "Log", "Differential", "File", "Differential File", "Partial Full", "Partial Differential"

---

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

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

### 推奨読解順序

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

まず、出力されるオブジェクトの構造と、使用される型（DbaSize, DbaTimeSpan, DbaDateTime）を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Measure-DbaBackupThroughput.ps1 | `public/Measure-DbaBackupThroughput.ps1` | 195-208行目のPSCustomObject定義で出力構造を確認 |

**読解のコツ**: DbaSize、DbaTimeSpan、DbaDateTimeはdbatools独自の型で、値の表示フォーマットを自動調整する。

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

処理の起点となるfunction定義とパラメータを確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Measure-DbaBackupThroughput.ps1 | `public/Measure-DbaBackupThroughput.ps1` | 128-141行目のparam定義でパラメータ構造を確認 |

**主要処理フロー**:
1. **143行目**: processブロック開始
2. **144-149行目**: SqlInstanceループとConnect-DbaInstance接続
3. **151-159行目**: データベースフィルタリング処理
4. **161-210行目**: データベースごとのバックアップ履歴取得と統計計算

#### Step 3: バックアップ履歴取得処理を理解する

Get-DbaDbBackupHistoryへの委譲処理を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Measure-DbaBackupThroughput.ps1 | `public/Measure-DbaBackupThroughput.ps1` | 166-170行目のGet-DbaDbBackupHistory呼び出し |

**主要処理フロー**:
- **166-167行目**: Since指定時の履歴取得
- **169行目**: Last指定時の履歴取得

#### Step 4: スループット計算ロジックを理解する

コア計算ロジックを確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | Measure-DbaBackupThroughput.ps1 | `public/Measure-DbaBackupThroughput.ps1` | 172-184行目のスループット計算とMBpsプロパティ追加 |

**主要処理フロー**:
- **173行目**: New-TimeSpanで所要時間計算
- **175-179行目**: スループット計算（ゼロ除算対応）
- **181行目**: Add-MemberでMBpsプロパティ追加

#### Step 5: 統計集計処理を理解する

Measure-Objectを使用した統計計算を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 5-1 | Measure-DbaBackupThroughput.ps1 | `public/Measure-DbaBackupThroughput.ps1` | 187-209行目の統計集計とオブジェクト生成 |

**主要処理フロー**:
- **189行目**: MBpsの平均、最小、最大を計算
- **190-193行目**: 日時、サイズ、所要時間の集計
- **195-208行目**: PSCustomObject生成

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

```
Measure-DbaBackupThroughput
    │
    ├─ Connect-DbaInstance
    │      └─ SQL Server接続確立
    │
    ├─ Get-DbaDbBackupHistory
    │      └─ msdbからバックアップ履歴取得
    │
    └─ Measure-Object
           └─ 統計計算（Average, Minimum, Maximum）
```

### データフロー図

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

SqlInstance ─────────────────► Connect-DbaInstance ─────────────►
Database パラメータ ─────────►                                    │
                                                                   │
                              Get-DbaDbBackupHistory ◄─────────────┘
                                      │
                                      ▼
msdb.dbo.backupset ─────────► バックアップ履歴レコード
                                      │
                                      ▼
                              スループット計算
                              (Size / Duration)
                                      │
                                      ▼
                              Measure-Object統計集計
                                      │
                                      ▼
                              PSCustomObject ─────────► パイプライン出力
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Measure-DbaBackupThroughput.ps1 | `public/Measure-DbaBackupThroughput.ps1` | ソース | メイン機能実装 |
| Measure-DbaBackupThroughput.Tests.ps1 | `tests/Measure-DbaBackupThroughput.Tests.ps1` | テスト | Pesterテストコード |
| Get-DbaDbBackupHistory.ps1 | `public/Get-DbaDbBackupHistory.ps1` | ソース | バックアップ履歴取得（依存コマンド） |
