# 機能設計書 637-Get-DbaDbVirtualLogFile

## 概要

本ドキュメントは、dbatools PowerShellモジュールのGet-DbaDbVirtualLogFileコマンドレットの機能設計書である。このコマンドは、DBCC LOGINFOを使用してトランザクションログ内の仮想ログファイル（VLF）メタデータを取得し、パフォーマンス分析とトラブルシューティングに必要な情報を提供する。

### 本機能の処理概要

Get-DbaDbVirtualLogFileは、データベーストランザクションログ内の各仮想ログファイル（VLF）に関する詳細なメタデータを返す。VLFサイズ、ファイルオフセット、シーケンス番号、ステータス、パリティ情報など、トランザクションログの構造とパフォーマンスの分析に不可欠な情報を提供する。

**業務上の目的・背景**：仮想ログファイル（VLF）の数が多すぎると、データベースのパフォーマンスに悪影響を及ぼす可能性がある。VLFが多すぎると、トランザクションログのバックアップが遅くなり、データベースの復旧も遅くなる。極端な場合には、INSERT/UPDATE/DELETEのパフォーマンスにも影響する。このコマンドは、VLF数が過剰（通常50〜100以上）なデータベースの特定、VLFサイズ分布の分析によるフラグメンテーション問題の発見、アクティブトランザクション中のVLFステータス監視に役立つ。

**機能の利用シーン**：
- VLF数が過剰なデータベースの特定
- トランザクションログパフォーマンス問題のトラブルシューティング
- ログファイル成長設定の最適化検討
- データベース復旧時間の予測
- ログ管理メンテナンス計画の立案

**主要な処理内容**：
1. 指定されたSQL Serverインスタンスに接続
2. 対象データベースをフィルタリング
3. 各データベースに対してDBCC LOGINFOを実行
4. 結果をPSCustomObjectとして出力

**関連システム・外部連携**：Expand-DbaDbLogFile（VLF数削減）、Get-DbaDbFile（ログファイル情報）と連携

**権限による制御**：DBCC LOGINFO実行権限（通常sysadmin、db_owner、またはVIEW SERVER STATE）が必要

## 関連画面

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

## 機能種別

データ取得 / 診断情報収集

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | Yes | 対象SQL Serverインスタンス。必須、複数指定可、パイプライン入力対応 | なし |
| SqlCredential | PSCredential | No | 代替認証情報 | Windows認証、SQL認証、AD認証対応 |
| Database | object[] | No | 対象データベース。ワイルドカード対応 | なし |
| ExcludeDatabase | object[] | No | 除外データベース。ワイルドカード対応 | なし |
| IncludeSystemDBs | switch | No | システムデータベースを含める | なし |
| EnableException | switch | No | 例外を有効にして詳細なエラー情報を取得 | なし |

### 入力データソース

- SQL Serverインスタンスに直接接続し、DBCC LOGINFOコマンドを実行

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | String | SQL Serverインスタンスのコンピュータ名 |
| InstanceName | String | SQL Serverインスタンス名 |
| SqlInstance | String | 完全なSQL Serverインスタンス名 |
| Database | String | データベース名 |
| RecoveryUnitId | Int | VLFの回復ユニット識別子 |
| FileId | Int | トランザクションログファイルID（通常0） |
| FileSize | Long | VLFのサイズ（バイト単位） |
| StartOffset | Long | ログファイル内のVLF開始オフセット（バイト単位） |
| FSeqNo | Long | 仮想ログファイルシーケンス番号 |
| Status | Int | VLFステータス（0=未使用、1=アクティブ、2=回復可能） |
| Parity | Int | 回復追跡とバックアップ検証用のパリティ値 |
| CreateLsn | String | VLFが作成されたログシーケンス番号（LSN） |

### 出力先

PowerShellパイプライン（PSCustomObject）

## 処理フロー

### 処理シーケンス

```
1. インスタンス接続
   └─ Connect-DbaInstanceで接続確立
   └─ 接続失敗時はStop-Function -Continue

2. データベースフィルタリング
   └─ IsAccessibleなデータベースを取得
   └─ Databaseパラメータでフィルタ
   └─ ExcludeDatabaseパラメータで除外
   └─ IncludeSystemDBs未指定時はシステムDBを除外

3. データベースごとの処理ループ
   └─ 各データベースに対して処理実行

4. DBCC LOGINFO実行
   └─ db.Query("DBCC LOGINFO")で実行
   └─ エラー時はStop-Function -Continue

5. 結果処理と出力
   └─ 各行をPSCustomObjectとして出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[インスタンスループ]
    B --> C[Connect-DbaInstance]
    C --> D{接続成功?}
    D -->|No| E[Stop-Function -Continue]
    D -->|Yes| F[データベース取得]
    E --> B2{次のインスタンス?}
    F --> G{Database指定?}
    G -->|Yes| H[Databaseフィルタ]
    G -->|No| I{ExcludeDatabase指定?}
    H --> I
    I -->|Yes| J[ExcludeDatabase除外]
    I -->|No| K{IncludeSystemDBs?}
    J --> K
    K -->|No| L[システムDB除外]
    K -->|Yes| M[データベースループ]
    L --> M
    M --> N[DBCC LOGINFO実行]
    N --> O{成功?}
    O -->|No| P[Stop-Function -Continue]
    O -->|Yes| Q[結果ループ]
    P --> R{次のDB?}
    Q --> S[PSCustomObject出力]
    S --> R
    R -->|Yes| M
    R -->|No| B2
    B2 -->|Yes| B
    B2 -->|No| T[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | システムDB除外 | デフォルトではシステムデータベースを除外 | IncludeSystemDBs未指定時 |
| BR-002 | アクセス可能性確認 | IsAccessible=Trueのデータベースのみ処理 | 全データベース |
| BR-003 | DBCC LOGINFO実行 | db.Query()でDBCC LOGINFOを実行 | 各データベース |
| BR-004 | VLFステータス定義 | 0=未使用、1=アクティブ、2=回復可能 | ステータス値 |

### 計算ロジック

本コマンドには計算ロジックなし。DBCC LOGINFOの結果をそのまま出力。

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| VLF情報取得 | （なし - DBCCコマンド） | DBCC | DBCC LOGINFOでVLFメタデータ取得 |

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

#### DBCC LOGINFO

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| DBCC | RecoveryUnitId, FileId, FileSize, StartOffset, FSeqNo, Status, Parity, CreateLSN | 全VLF | SQL Server 2012+ではRecoveryUnitIdが追加 |

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

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

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

## パフォーマンス要件

- DBCC LOGINFOは軽量な操作であり、パフォーマンスへの影響は最小
- 多数のデータベースを処理する場合、順次処理のため時間がかかる

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

- DBCC LOGINFO実行権限が必要（通常sysadmin、db_owner）
- SqlCredentialパラメータでSQL認証、Windows認証、AD認証をサポート

## 備考

- VLF数が50〜100を超える場合はExpand-DbaDbLogFileでの圧縮を検討
- 参考URL: http://www.sqlskills.com/blogs/kimberly/transaction-log-vlfs-too-many-or-too-few/
- 参考URL: http://blogs.msdn.com/b/saponsqlserver/archive/2012/02/22/too-many-virtual-log-files-vlfs-can-cause-slow-database-recovery.aspx
- Group-Object -Property Databaseを使用してデータベースごとのVLF数を集計可能

---

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

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

### 推奨読解順序

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

DBCC LOGINFOの出力構造を理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Get-DbaDbVirtualLogFile.ps1 | `public/Get-DbaDbVirtualLogFile.ps1` | 135-148行目の出力オブジェクト構造 |

**読解のコツ**: DBCC LOGINFOの出力列名（RecoveryUnitId、FileId、FileSize等）がそのままプロパティ名として使用されている。

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

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

**主要処理フロー**:
1. **110-115行目**: Connect-DbaInstanceで接続
2. **117行目**: IsAccessibleなデータベースを取得

#### Step 3: データベースフィルタリングを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Get-DbaDbVirtualLogFile.ps1 | `public/Get-DbaDbVirtualLogFile.ps1` | 117-128行目のフィルタリングロジック |

**主要処理フロー**:
- **119-121行目**: Databaseパラメータでフィルタ
- **122-124行目**: ExcludeDatabaseで除外
- **126-128行目**: IncludeSystemDBs未指定時のシステムDB除外

#### Step 4: DBCC LOGINFO実行を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | Get-DbaDbVirtualLogFile.ps1 | `public/Get-DbaDbVirtualLogFile.ps1` | 130-153行目のDBCC実行と結果処理 |

**主要処理フロー**:
- **132行目**: db.Query("DBCC LOGINFO")実行
- **134-149行目**: 結果のPSCustomObject変換

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

```
Get-DbaDbVirtualLogFile
    │
    ├─ Connect-DbaInstance
    │      └─ SQL Server接続確立
    │
    ├─ server.Databases（フィルタリング）
    │      ├─ IsAccessibleチェック
    │      ├─ Databaseフィルタ
    │      ├─ ExcludeDatabase除外
    │      └─ SystemObjectフィルタ
    │
    ├─ db.Query("DBCC LOGINFO")
    │      └─ VLFメタデータ取得
    │
    └─ Stop-Function
           └─ エラー処理
```

### データフロー図

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

SqlInstance           ───▶ Connect-DbaInstance
                                 │
                                 ▼
Database/ExcludeDB    ───▶ データベースフィルタリング
                                 │
                                 ▼
                           DBCC LOGINFO
                                 │
                                 ▼
                           結果変換               ───▶ PSCustomObject
                                                      - RecoveryUnitId
                                                      - FileId
                                                      - FileSize
                                                      - Status
                                                      - FSeqNo
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Get-DbaDbVirtualLogFile.ps1 | `public/Get-DbaDbVirtualLogFile.ps1` | ソース | メイン処理ロジック |
| Expand-DbaDbLogFile.ps1 | `public/Expand-DbaDbLogFile.ps1` | ソース | 関連コマンド（VLF数削減） |
| Get-DbaDbFile.ps1 | `public/Get-DbaDbFile.ps1` | ソース | 関連コマンド（ログファイル情報） |
| Connect-DbaInstance.ps1 | `public/Connect-DbaInstance.ps1` | ソース | 内部依存（インスタンス接続） |
