# 機能設計書 628-Expand-DbaDbLogFile

## 概要

本ドキュメントは、dbatools PowerShellモジュールの`Expand-DbaDbLogFile`コマンドレットに関する機能設計書である。このコマンドレットは、Virtual Log File (VLF)の断片化を防止しながらトランザクションログファイルを拡張する機能を提供する。

### 本機能の処理概要

**業務上の目的・背景**：VLF（仮想ログファイル）の過剰な断片化は、トランザクションログのバックアップ遅延、データベース起動時のリカバリ遅延、極端な場合はINSERT/UPDATE/DELETE性能の低下を引き起こす。この機能は、SQL Serverのバージョンに応じた最適な増分サイズを計算し、制御されたチャンクでログファイルを拡張することで、これらの問題を予防的に解決する。

**機能の利用シーン**：
- 新規データベースのログファイル初期設定
- 既存ログファイルのVLF断片化修正
- トランザクション量増加に伴うログファイル事前拡張
- ログファイルのパフォーマンスチューニング

**主要な処理内容**：
1. 対象SQL Serverインスタンスへの接続確立
2. 対象データベースとログファイルの特定
3. 現在のサイズとVLF数の取得
4. ディスク空き容量の検証（オプション）
5. ShrinkLogFile指定時はログバックアップ後にシュリンク
6. SQL Serverバージョンに基づく最適増分サイズの計算
7. 段階的なログファイル拡張の実行
8. 拡張後のVLF数と状態の出力

**関連システム・外部連携**：
- SQL Server Management Objects (SMO)
- ファイルシステム（ディスク容量確認）
- バックアップサブシステム（シュリンク時）

**権限による制御**：ALTER DATABASE権限が必要。シュリンク時はBACKUP権限も必要。

## 関連画面

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

## 機能種別

ファイル操作 / パフォーマンスチューニング

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter | Yes | 対象SQL Serverインスタンス | - |
| SqlCredential | PSCredential | No | SQL Server接続用資格情報 | - |
| Database | object[] | No | 対象データベース名 | ワイルドカード可 |
| ExcludeDatabase | object[] | No | 除外するデータベース名 | ワイルドカード可 |
| TargetLogSize | int | Yes | 目標ログファイルサイズ（MB） | 正の整数 |
| IncrementSize | int | No | 拡張増分サイズ（MB）、未指定時は自動計算 | 正の整数、デフォルト-1 |
| LogFileId | int | No | 対象ログファイルID（複数ログファイル時） | デフォルト-1（最初のログファイル） |
| ShrinkLogFile | switch | No | 拡張前にログファイルをシュリンク | - |
| ShrinkSize | int | 条件付き | シュリンク後のサイズ（MB）（ShrinkLogFile時必須） | 正の整数 |
| BackupDirectory | string | No | シュリンク用ログバックアップのディレクトリ | 有効なパス |
| ExcludeDiskSpaceValidation | switch | No | ディスク空き容量チェックをスキップ | - |
| EnableException | switch | No | 例外処理モード切替 | - |

### 入力データソース

- PowerShellコマンドラインからのパラメータ入力
- テキストファイルからのデータベース名リスト

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | コンピュータ名 |
| InstanceName | string | インスタンス名 |
| SqlInstance | string | 完全インスタンス名 |
| Database | string | データベース名 |
| DatabaseID | int | データベースID |
| ID | int | ログファイルID |
| Name | string | ログファイル論理名 |
| InitialSize | dbasize | 処理前のサイズ |
| CurrentSize | dbasize | 処理後のサイズ |
| InitialVLFCount | int | 処理前のVLF数 |
| CurrentVLFCount | int | 処理後のVLF数 |

### 出力先

PowerShellパイプライン（PSCustomObject）

## 処理フロー

### 処理シーケンス

```
1. begin ブロック
   └─ 1.1 MB→KB変換（SMOはKB単位）
   └─ 1.2 Connect-DbaInstanceで接続
   └─ 1.3 シュリンク時はバックアップディレクトリ検証
2. process ブロック（各データベースごと）
   └─ 2.1 対象ログファイル特定（LogFileId or 最初のファイル）
   └─ 2.2 現在サイズとVLF数取得
   └─ 2.3 ディスク空き容量検証（オプション）
   └─ 2.4 ShrinkLogFile時のシュリンク処理
         └─ シンプルリカバリでないことを確認
         └─ トランザクションログバックアップ実行（ループ）
         └─ Shrinkメソッド実行
   └─ 2.5 SQL Serverバージョンに基づく増分サイズ計算
   └─ 2.6 ループによる段階的拡張
         └─ 目標サイズに達するまでIncrementSizeずつ拡張
         └─ 各ステップでAlter()実行
   └─ 2.7 最終VLF数取得
   └─ 2.8 結果オブジェクト出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[パラメータ変換/接続]
    B --> C[foreach database]
    C --> D[ログファイル特定]
    D --> E[現在サイズ/VLF取得]
    E --> F{ディスク容量OK?}
    F -->|No| G[エラー/スキップ]
    G --> C
    F -->|Yes| H{ShrinkLogFile?}
    H -->|Yes| I{Simpleリカバリ?}
    I -->|Yes| J[警告: シュリンク不可]
    J --> C
    I -->|No| K[ログバックアップ&シュリンク]
    K --> L[増分サイズ計算]
    H -->|No| L
    L --> M{現在サイズ < 目標?}
    M -->|No| N[既に目標以上]
    N --> O[結果出力]
    M -->|Yes| P[ログファイル拡張]
    P --> Q[Alter実行]
    Q --> R{目標達成?}
    R -->|No| P
    R -->|Yes| S[最終VLF取得]
    S --> O
    O --> C
    C --> T[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | バージョン別増分計算 | SQL Server 2012+と2008R2以下で異なるアルゴリズム | 常時 |
| BR-002 | 4GB倍数回避 | SQL 2012未満では4GBの倍数は使用不可（既知バグ） | SQL 2012未満 |
| BR-003 | Simpleリカバリ制限 | Simpleリカバリモードではシュリンク不可 | ShrinkLogFile時 |
| BR-004 | シュリンクループ | 目標サイズに達するまで最大5回バックアップ&シュリンク | ShrinkLogFile時 |
| BR-005 | MB単位入力 | 入力はMB単位、内部はKB単位で処理 | 常時 |

### 計算ロジック

**SQL Server 2012以上の増分サイズ計算:**
- 64MB以下 → 64MB
- 64-256MB → 256MB
- 256MB-1GB → 512MB
- 1-4GB → 1024MB
- 4-8GB → 2048MB
- 8-16GB → 4096MB
- 16GB以上 → 8192MB

**SQL Server 2008R2以下の増分サイズ計算:**
- 64MB以下 → 64MB
- 64-256MB → 256MB
- 256MB-1GB → 512MB
- 1-4GB → 1024MB
- 4-8GB → 2048MB
- 8-16GB → 4000MB（4096ではない - 4GB倍数バグ回避）
- 16GB以上 → 8000MB（8192ではない - 4GB倍数バグ回避）

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| ログファイル拡張 | sys.database_files | UPDATE | ログファイルサイズ更新 |
| ログバックアップ | - | BACKUP | トランザクションログバックアップ |
| シュリンク | sys.database_files | UPDATE | ログファイルサイズ縮小 |

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

#### sys.database_files

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| UPDATE | size | 増分または目標サイズ | 8KBページ単位 |
| SELECT | file_id, name, physical_name, size | 現在の状態取得 | - |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | Stop-Function | 接続失敗 | 接続情報を確認 |
| - | Stop-Function | バックアップディレクトリ不存在 | 有効なパスを指定 |
| - | Warning | ディスク容量不足 | ディスク空き容量確保 |
| - | Warning | Simpleリカバリでシュリンク | ShrinkLogFileを使用しない |
| - | Stop-Function | バックアップ失敗 | 権限、パスを確認 |

### リトライ仕様

シュリンク時のログバックアップは最大5回リトライ

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

SMOのAlter()メソッドによる暗黙的トランザクション。各拡張ステップは個別にコミット。

## パフォーマンス要件

- 大規模ログファイル拡張は時間がかかる可能性あり
- ディスクI/Oに依存
- シュリンク処理は特に時間を要する

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

- ALTER DATABASE権限が必要
- シュリンク時はBACKUP権限も必要
- バックアップファイルの出力先パスへの書き込み権限

## 備考

- SQL Server 2005のディスク容量検証には制限あり
- Write-Progressによる進捗表示あり
- 段階的拡張によりVLF最適化を実現
- Paul Randalの推奨事項に基づいた実装

---

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

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

### 推奨読解順序

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

出力オブジェクトとVLF概念を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Expand-DbaDbLogFile.ps1 | `public/Expand-DbaDbLogFile.ps1` | .OUTPUTS セクション - PSCustomObject構造 |

**読解のコツ**: VLF（Virtual Log File）はトランザクションログの内部分割単位。過多なVLFは性能問題の原因となる。

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

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

**主要処理フロー**:
1. **165-189行目**: パラメータ定義（ParameterSetName: Default/Shrink）
2. **191-227行目**: beginブロック - 変数初期化、接続、パス検証
3. **229-528行目**: processブロック - メイン処理

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Expand-DbaDbLogFile.ps1 | `public/Expand-DbaDbLogFile.ps1` | 増分サイズ計算とログ拡張ロジック |

**主要処理フロー**:
- **271-276行目**: ログファイル特定（LogFileId or 最初）
- **284行目**: 初期VLF数取得（Measure-DbaDbVirtualLogFile）
- **289-338行目**: ディスク容量検証
- **346-374行目**: SQL 2012+の増分サイズ計算（switch文）
- **357-373行目**: SQL 2008R2以下の増分サイズ計算
- **378-444行目**: シュリンク処理（バックアップループ含む）
- **458-494行目**: ログファイル拡張ループ
- **508-523行目**: 結果オブジェクト生成

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

```
Expand-DbaDbLogFile
    │
    ├─ Connect-DbaInstance (SQL接続)
    │
    ├─ Test-DbaPath (パス検証)
    │
    ├─ Get-DbaDiskSpace (ディスク容量取得)
    │
    ├─ Measure-DbaDbVirtualLogFile (VLF数取得)
    │
    ├─ [ShrinkLogFile時]
    │      ├─ SMO Backup.SqlBackup() (ログバックアップ)
    │      └─ LogFile.Shrink() (シュリンク)
    │
    ├─ [拡張ループ]
    │      ├─ LogFile.Size = newSize
    │      └─ LogFile.Alter()
    │
    └─ 結果オブジェクト出力
```

### データフロー図

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

SqlInstance/Database ───▶ Connect-DbaInstance ─────────▶ Server object
                                │
TargetLogSize ──────────────────▶
                                │
                                ▼
                          ログファイル特定
                          VLF数取得
                                │
IncrementSize ──────────────────▶ 増分サイズ計算
(自動 or 指定)                  （バージョン別）
                                │
                                ▼
                          [ShrinkLogFile]
                          バックアップ&シュリンク
                                │
                                ▼
                          拡張ループ ────────────────▶ 物理ファイル拡張
                          (段階的にAlter)
                                │
                                ▼
                          結果オブジェクト ──────────▶ PSCustomObject
                          (VLF数変化含む)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Expand-DbaDbLogFile.ps1 | `public/Expand-DbaDbLogFile.ps1` | ソース | メインコマンドレット |
| Measure-DbaDbVirtualLogFile.ps1 | `public/Measure-DbaDbVirtualLogFile.ps1` | ソース | VLF数測定 |
| Get-DbaDiskSpace.ps1 | `public/Get-DbaDiskSpace.ps1` | ソース | ディスク容量取得 |
| Test-DbaPath.ps1 | `public/Test-DbaPath.ps1` | ソース | パス検証 |
