# 機能設計書 65-Get-DbaDbDbccOpenTran

## 概要

本ドキュメントは、dbatools PowerShellモジュールにおける `Get-DbaDbDbccOpenTran` コマンドレットの機能設計書です。DBCC OPENTRANコマンドを使用して、データベーストランザクションログ内の最も古いアクティブトランザクションを特定する機能について、その仕様と実装詳細を記述します。

### 本機能の処理概要

`Get-DbaDbDbccOpenTran` は、SQL ServerのDBCC OPENTRANコマンドを実行し、データベーストランザクションログ内で最も古いアクティブなトランザクションを特定するコマンドレットです。長時間実行されているトランザクションや問題のあるトランザクションを検出し、構造化されたPowerShellオブジェクトとして結果を返します。

**業務上の目的・背景**：トランザクションが長時間オープンのままになると、トランザクションログの切り捨てが妨げられ、ログファイルの肥大化やレプリケーションの遅延、ブロッキングの原因となります。本機能を使用することで、DBAは問題のあるトランザクションを迅速に特定し、適切な対処（トランザクションの終了、アプリケーションの調査等）を行うことができます。

**機能の利用シーン**：
- トランザクションログの急激な増大の調査
- ブロッキングチェーンの原因特定
- レプリケーション遅延のトラブルシューティング
- 分散トランザクションの問題調査
- 定期的なデータベースヘルスチェック

**主要な処理内容**：
1. SQL Serverインスタンスへの接続
2. 対象データベースの列挙
3. 各データベースに対してDBCC OPENTRANを実行
4. 結果を構造化オブジェクトとして出力

**関連システム・外部連携**：
- SQL Server インスタンス
- トランザクションログ（読み取りのみ）

**権限による制御**：
- DBCC OPENTRANの実行にはサーバーレベルのVIEW SERVER STATE権限が必要
- または対象データベースのdb_owner権限

## 関連画面

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

## 機能種別

データベース診断（読み取り専用）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | Yes | 接続先SQL Serverインスタンス | Mandatory, パイプライン入力可 |
| SqlCredential | PSCredential | No | 認証用資格情報 | - |
| Database | string[] | No | 対象データベース名またはID | - |
| EnableException | switch | No | 例外を有効にするフラグ | - |

### 入力データソース

- SQL Server インスタンスへの接続

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | SQL Serverのコンピュータ名 |
| InstanceName | string | SQL Serverインスタンス名（サービス名） |
| SqlInstance | string | 完全なSQL Server名（DomainInstanceName） |
| Database | string | データベース名 |
| DatabaseId | int | データベースID |
| Cmd | string | 実行されたDBCCコマンド |
| Output | string | 結果概要メッセージ |
| Field | string | DBCC出力のフィールド名（Transaction ID, SPID等） |
| Data | string | フィールドに対応する値 |

### 出力先

PowerShellパイプライン（PSCustomObject）

## 処理フロー

### 処理シーケンス

```
1. SQLクエリテンプレート準備
   └─ DBCC OPENTRAN(#options#) WITH TABLERESULTS, NO_INFOMSGS
2. インスタンス接続
   └─ Connect-DbaInstanceでSQL Server接続
3. データベース列挙
   └─ server.Databasesから対象DBを取得
4. データベースフィルタリング（Database指定時）
   └─ 名前またはIDでフィルタ
5. 各データベースに対して処理
   └─ アクセス可能性チェック
   └─ DBCC OPENTRAN実行
   └─ 結果をPSCustomObjectとして出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[クエリテンプレート準備]
    B --> C[インスタンスループ開始]
    C --> D[Connect-DbaInstance]
    D --> E{接続成功?}
    E -->|No| F[Stop-Function]
    E -->|Yes| G[データベース一覧取得]
    G --> H{Database指定?}
    H -->|Yes| I[名前/IDでフィルタ]
    H -->|No| J[全データベース対象]
    I --> K[データベースループ開始]
    J --> K
    K --> L{IsAccessible?}
    L -->|No| M[スキップ]
    L -->|Yes| N[DBCC OPENTRAN実行]
    N --> O{結果あり?}
    O -->|No| P[No active open transactions出力]
    O -->|Yes| Q[トランザクション情報出力]
    P --> R{次のDB?}
    Q --> R
    M --> R
    R -->|Yes| K
    R -->|No| S{次のインスタンス?}
    S -->|Yes| C
    S -->|No| T[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-01 | アクセス不可DBスキップ | IsAccessibleがfalseのデータベースはスキップ | 常時 |
| BR-02 | 結果なし時の出力 | 結果がnullの場合は「No active open transactions.」を出力 | 結果なし時 |
| BR-03 | Database指定フィルタ | DatabaseパラメータはNameまたはIDでマッチング | Database指定時 |

### 計算ロジック

該当なし

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| DBCC OPENTRAN | トランザクションログ | SELECT（読み取り） | オープントランザクション情報の取得 |

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

データベースへの書き込みは行いません。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | 接続失敗 | SQL Serverへの接続に失敗 | 接続情報を確認 |
| - | DB非アクセス | データベースがアクセス不可 | DBの状態を確認 |
| - | 権限不足 | VIEW SERVER STATE権限がない | 権限を付与 |
| - | DBCC実行エラー | DBCC OPENTRANの実行に失敗 | エラー詳細を確認 |

### リトライ仕様

リトライ処理なし

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

該当なし（読み取り専用操作）

## パフォーマンス要件

- 軽量な診断コマンドのため、即座に完了
- 多数のデータベースがある場合は順次処理

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

- VIEW SERVER STATE権限またはdb_owner権限が必要
- 読み取り専用操作のため、データへの影響なし

## 備考

- DBCC OPENTRANはSQL Server 2005以降で利用可能
- WITH TABLERESULTSオプションで構造化された結果を取得

---

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

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

### 推奨読解順序

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

出力されるPSCustomObjectの構造を理解します。

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

**読解のコツ**: 結果ありの場合とnullの場合で出力構造が同じだが、Field/Dataの値が異なることに注意。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Get-DbaDbDbccOpenTran.ps1 | `public/Get-DbaDbDbccOpenTran.ps1` | 85-92行目: パラメータ定義 |

**主要処理フロー**:
1. **85-92行目**: パラメータ定義（SqlInstance必須）
2. **93-95行目**: begin ブロック - クエリテンプレート準備
3. **97-159行目**: process ブロック - メイン処理

#### Step 3: DBCCコマンド実行ロジックを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Get-DbaDbDbccOpenTran.ps1 | `public/Get-DbaDbDbccOpenTran.ps1` | 処理ロジック |

**主要処理フロー**:
- **94-95行目**: StringBuilderでDBCCコマンドテンプレート構築
- **108-109行目**: Databaseパラメータによるフィルタリング
- **120-121行目**: クエリのデータベース名置換
- **123-124行目**: server.Query()でDBCC実行
- **130-156行目**: 結果の出力処理

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

```
Get-DbaDbDbccOpenTran (public/Get-DbaDbDbccOpenTran.ps1)
    │
    ├─ Connect-DbaInstance
    │      └─ SQL Server接続
    │
    ├─ server.Databases (SMO)
    │      └─ データベース一覧取得
    │
    └─ server.Query()
           └─ DBCC OPENTRAN('dbname') WITH TABLERESULTS, NO_INFOMSGS
```

### データフロー図

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

SqlInstance ──────▶ Connect-DbaInstance ──┐
                                          │
Database ─────────▶ フィルタリング ────────┤
                                          │
                                          ▼
                                   DBCC OPENTRAN実行
                                          │
                              ┌───────────┴───────────┐
                              ▼                       ▼
                        結果あり                   結果なし
                              │                       │
                              ▼                       ▼
                    トランザクション情報      "No active open transactions."
                              │                       │
                              └───────────┬───────────┘
                                          ▼
                                   PSCustomObject
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Get-DbaDbDbccOpenTran.ps1 | `public/Get-DbaDbDbccOpenTran.ps1` | ソース | メイン実装ファイル |
| Get-DbaDbDbccOpenTran.Tests.ps1 | `tests/Get-DbaDbDbccOpenTran.Tests.ps1` | テスト | 単体テスト |
