# 機能設計書 197-Read-DbaTransactionLog

## 概要

本ドキュメントは、dbatools PowerShellモジュールにおける`Read-DbaTransactionLog`機能の設計仕様を記載する。この機能は、fn_dblog関数を使用してデータベースからトランザクションログレコードを取得し、フォレンジック分析やトラブルシューティングに使用する。

### 本機能の処理概要

**業務上の目的・背景**：データベースのフォレンジック分析において、「いつ、誰が、何を変更したか」を特定する必要がある場合がある。SQL Serverのfn_dblog関数は、トランザクションログの生データにアクセスする手段を提供する。本機能は、このfn_dblogの出力をPowerShellオブジェクトとして取得し、データ変更の追跡、削除されたレコードの復元調査、トランザクションパターンの分析などを可能にする。

**機能の利用シーン**：
- データ削除・変更の原因調査
- トランザクションシーケンスの再構築
- パフォーマンス問題のトランザクションパターン分析
- 不正アクセスの痕跡調査

**主要な処理内容**：
1. SQL Serverインスタンスに接続
2. データベースの存在と状態を確認
3. トランザクションログサイズの安全チェック（0.5GB制限）
4. fn_dblog(NULL, NULL)を実行してログレコードを取得
5. 結果をPSCustomObjectとして返却

**関連システム・外部連携**：SQL Server（fn_dblog関数）。

**権限による制御**：fn_dblogにアクセスするにはsysadmin権限またはdb_owner権限が必要。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 237 | トランザクションログ読み取り | 主機能 | トランザクションログの読み取り |

## 機能種別

データ取得 / フォレンジック分析

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter | Yes | 対象SQL Serverインスタンス | Mandatory |
| SqlCredential | PSCredential | No | SQL Server認証情報 | - |
| Database | object | Yes | 対象データベース名 | Mandatory |
| IgnoreLimit | switch | No | 0.5GB制限を無視 | - |
| RowLimit | int | No | 取得行数制限（デフォルト: 0=無制限） | - |
| EnableException | switch | No | 例外をスローするかどうか | - |

### 入力データソース

パラメータ入力のみ。

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| TransactionLogRecord | PSCustomObject[] | fn_dblogの出力レコード |

### 主要な出力プロパティ

| プロパティ名 | 説明 |
|-------------|------|
| RecoveryUnitId | リカバリユニットID |
| LSN | ログシーケンス番号 |
| LOP | ログ操作タイプ（INSERT, DELETE等） |
| Transaction ID | トランザクションID |
| BeginTime | 操作開始時刻 |
| AllocUnitName | アロケーションユニット名 |
| RowIdentifier | 行識別子 |
| ObjectId | オブジェクトID |
| IndexId | インデックスID |
| PageId | ページID |

### 出力先

PowerShellパイプラインへの出力。

## 処理フロー

### 処理シーケンス

```
1. Connect-DbaInstanceで接続
2. データベース存在確認
3. データベース状態確認（Normal以外はエラー）
4. RowLimit指定時
   └─ TOP句追加、IgnoreLimit自動有効
5. IgnoreLimit未指定時
   ├─ トランザクションログサイズ取得
   └─ 500MB超過でエラー
6. fn_dblog実行
   └─ SELECT [TOP n] * FROM fn_dblog(NULL, NULL)
7. 結果返却
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[Connect-DbaInstance]
    B --> C{接続成功?}
    C -->|No| D[Stop-Function 終了]
    C -->|Yes| E{DB存在?}
    E -->|No| F[Stop-Function DB未存在]
    E -->|Yes| G{DB状態 Normal?}
    G -->|No| H[Stop-Function 状態異常]
    G -->|Yes| I{RowLimit指定?}
    I -->|Yes| J[TOP句設定, IgnoreLimit=true]
    I -->|No| K{IgnoreLimit?}
    J --> L[fn_dblog実行]
    K -->|Yes| L
    K -->|No| M[ログサイズ取得]
    M --> N{サイズ >= 500MB?}
    N -->|Yes| O[Stop-Function サイズ超過]
    N -->|No| L
    L --> P[結果返却]
    P --> Q[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | 安全制限 | トランザクションログ0.5GB以上でブロック | IgnoreLimit未指定時 |
| BR-002 | 状態チェック | Normal状態以外のDBはエラー | 常時 |
| BR-003 | RowLimit連動 | RowLimit指定でIgnoreLimit自動有効 | RowLimit > 0 |

### 計算ロジック

**トランザクションログサイズ取得SQL**:
```sql
SELECT
    SUM(FileProperty(sf.name,'spaceused')*8/1024) AS 'SizeMb'
FROM sys.sysfiles sf
WHERE CONVERT(INT,sf.status & 0x40) / 64=1
```

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| fn_dblog | - | SELECT | トランザクションログレコード取得 |
| サイズチェック | sys.sysfiles | SELECT | ログファイルサイズ取得 |

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

#### fn_dblogクエリ

```sql
SELECT [TOP n] * FROM fn_dblog(NULL, NULL)
```

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ConnectionError | SQL Server接続失敗 | 接続情報を確認 |
| - | Stop-Function | データベース未存在 | DB名を確認 |
| - | Stop-Function | データベース状態異常 | DBを正常状態に戻す |
| - | Stop-Function | ログサイズ超過 | IgnoreLimit使用または別手段 |

### リトライ仕様

本機能にリトライ機能はない。

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

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

## パフォーマンス要件

- 0.5GB制限はパフォーマンス影響を考慮した設計
- 大規模ログ読み取りはSQL Serverとクライアント双方に影響
- RowLimitによる段階的取得を推奨

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

- fn_dblogはsysadminまたはdb_owner権限が必要
- トランザクションログには機密データが含まれる可能性
- 出力データの取り扱いに注意

## 備考

- fn_dblogの出力カラムはSQL Serverバージョンにより異なる
- NULL, NULLパラメータはログ全体を対象とする
- 特定LSN範囲を指定する場合は直接fn_dblogを呼び出す

---

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

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

### 推奨読解順序

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

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Read-DbaTransactionLog.ps1 | `public/Read-DbaTransactionLog.ps1` | OUTPUTS説明（40-63行目） |

**読解のコツ**: fn_dblogはSQL Server内部のログレコード構造をそのまま出力する。LSN、LOP、Transaction IDが主要な識別子。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Read-DbaTransactionLog.ps1 | `public/Read-DbaTransactionLog.ps1` | 関数定義とパラメータ構造 |

**主要処理フロー**:
1. **87-97行目**: param()ブロック
2. **99-104行目**: Connect-DbaInstance
3. **106-114行目**: DB存在・状態チェック
4. **116-122行目**: RowLimit処理
5. **124-138行目**: サイズチェック
6. **140-143行目**: fn_dblog実行

#### Step 3: 安全制限処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Read-DbaTransactionLog.ps1 | `public/Read-DbaTransactionLog.ps1` | サイズチェックロジック |

**主要処理フロー**:
- **125-126行目**: IgnoreLimit時の警告
- **128-133行目**: サイズ取得SQL
- **134行目**: サイズチェック実行
- **135-137行目**: 500MB超過時エラー

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

```
Read-DbaTransactionLog
    │
    ├─ Connect-DbaInstance
    │      └─ SQL Server接続
    │
    ├─ $server.databases[$Database]
    │      └─ DB存在確認
    │
    ├─ $server.Query() - サイズチェック
    │      └─ sys.sysfilesからログサイズ取得
    │
    └─ $server.Query() - fn_dblog
           └─ トランザクションログレコード取得
```

### データフロー図

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

SqlInstance ───────────────┐
                           │
SqlCredential ─────────────┼──▶ Connect-DbaInstance
                           │           │
Database ──────────────────┼──▶ DB存在・状態チェック
                           │           │
IgnoreLimit ───────────────┼──▶ サイズ制限チェック
                           │           │
RowLimit ──────────────────┼──▶ fn_dblog実行 ──────────────────▶ PSCustomObject[]
                                 │                                  (ログレコード群)
                                 └─ SELECT * FROM fn_dblog(NULL,NULL)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Read-DbaTransactionLog.ps1 | `public/Read-DbaTransactionLog.ps1` | ソース | メイン関数定義 |
| Connect-DbaInstance.ps1 | `public/Connect-DbaInstance.ps1` | ソース | SQL Server接続 |
