# 機能設計書 413-Get-DbaWaitResource

## 概要

本ドキュメントは、sys.dm_exec_requestsの暗号的な待機リソース識別子を人間が読めるデータベースオブジェクト情報に変換する`Get-DbaWaitResource`機能の設計を定義する。

### 本機能の処理概要

本機能は、ブロッキングやデッドロックのトラブルシューティング時にDMVで見られる'PAGE: 10:1:9180084'や'KEY: 7:35457594073541168 (de21f92a1572)'のような暗号的な待機リソース値を、実際のテーブルやインデックス情報に変換する。

**業務上の目的・背景**：ブロッキングチェーンやデッドロックを調査する際、wait_resource値は暗号的な形式で表示されるため、どのテーブルやインデックスが関係しているかが分からない。本機能はリソースIDを手動で解読する作業を排除し、本番環境でブロッキング問題の根本原因を迅速に特定する時間を節約する。

**機能の利用シーン**：
- ブロッキング問題の調査時
- デッドロック分析時
- ロック競合の原因特定
- パフォーマンストラブルシューティング

**主要な処理内容**：
1. 待機リソース文字列のフォーマット検証（PAGE/KEY形式）
2. PAGE待機: DBCC PAGEを使用してページ所有オブジェクトを特定
3. KEY待機: sys.partitions/sys.indexesから対象インデックスを特定
4. -Rowパラメータ: ロックされている実際のデータ行を取得

**関連システム・外部連携**：
- sys.dm_exec_requests (待機リソースの取得元)
- sys.master_files (データファイル情報)
- sys.partitions, sys.indexes, sys.all_objects (KEY解決用)
- DBCC PAGE (PAGE解決用)

**権限による制御**：VIEW SERVER STATE権限、対象データベースへのアクセス権限が必要

## 関連画面

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

## 機能種別

データ変換・診断処理

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstance | Yes | 対象SQL Serverインスタンス | 単一インスタンス |
| SqlCredential | PSCredential | No | 代替認証資格情報 | Windows/SQL認証対応 |
| WaitResource | string | Yes | 待機リソース識別子 | PAGE/KEY形式の正規表現チェック |
| Row | switch | No | ロック行のデータを取得 | KEY待機時のみ有効 |
| EnableException | switch | No | 例外の詳細表示有効化 | - |

### 入力データソース

- ユーザー入力: WaitResource文字列
- SQL Server: sys.master_files, sys.partitions, sys.indexes, sys.all_objects

## 出力仕様

### 出力データ

#### PAGE待機の場合

| 項目名 | 型 | 説明 |
|--------|-----|------|
| DatabaseID | int | データベースID |
| DatabaseName | string | データベース名 |
| DataFileName | string | データファイルの論理名 |
| DataFilePath | string | データファイルの物理パス |
| ObjectID | int | ページを所有するオブジェクトID |
| ObjectName | string | オブジェクト名（テーブル/インデックス） |
| ObjectSchema | string | スキーマ名 |
| ObjectType | string | オブジェクトタイプ（USER_TABLE, CLUSTERED_INDEX等） |

#### KEY待機の場合

| 項目名 | 型 | 説明 |
|--------|-----|------|
| DatabaseID | int | データベースID |
| DatabaseName | string | データベース名 |
| SchemaName | string | スキーマ名 |
| IndexName | string | インデックス名 |
| ObjectID | int | テーブルのオブジェクトID |
| ObjectName | string | テーブル名 |
| HobtID | bigint | ヒープまたはB-Tree ID |

#### -Row指定時（KEY待機）

上記に加えて、ロックされている行の実際のデータをObjectDataプロパティとして追加

### 出力先

PowerShellパイプライン(PSCustomObject)

## 処理フロー

### 処理シーケンス

```
1. processブロック: 待機リソースの解析
   └─ 1.1 正規表現でPAGE/KEY形式を検証
   └─ 1.2 Connect-DbaInstanceでサーバー接続
   └─ 1.3 リソースタイプとデータベースIDを抽出
   └─ 1.4 データベース名の取得と存在確認

2. PAGE処理:
   └─ 2.1 sys.master_filesからデータファイル情報取得
   └─ 2.2 DBCC TRACEON (3604) + DBCC PAGEでオブジェクトID取得
   └─ 2.3 sys.all_objectsからオブジェクト情報取得
   └─ 2.4 結果をPSCustomObjectとして出力

3. KEY処理:
   └─ 3.1 sys.partitions/indexes/all_objectsからインデックス情報取得
   └─ 3.2 基本情報をPSCustomObjectとして作成
   └─ 3.3 -Row指定時: %%lockres%%で行データを取得
   └─ 3.4 結果を出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{WaitResource形式チェック}
    B -->|不正| C[Stop-Function/return]
    B -->|正常| D[Connect-DbaInstance]
    D --> E[リソースタイプ・DB ID抽出]
    E --> F{DB存在確認}
    F -->|なし| G[Stop-Function/return]
    F -->|あり| H{リソースタイプ}
    H -->|PAGE| I[sys.master_files照会]
    I --> J{データファイル存在?}
    J -->|なし| K[Warning/return]
    J -->|あり| L[DBCC PAGE実行]
    L --> M[オブジェクトID取得]
    M --> N[sys.all_objects照会]
    N --> O[PSCustomObject出力]
    H -->|KEY| P[sys.partitions/indexes照会]
    P --> Q{インデックス存在?}
    Q -->|なし| R[Warning/return]
    Q -->|あり| S[PSCustomObject作成]
    S --> T{-Row指定?}
    T -->|No| U[出力]
    T -->|Yes| V[%%lockres%%で行取得]
    V --> W{行存在?}
    W -->|なし| X[Warning + 基本出力]
    W -->|あり| Y[ObjectData追加 + 展開出力]
    O --> Z[終了]
    U --> Z
    X --> Z
    Y --> Z
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | 形式検証 | PAGE: dbid:fileid:pageid または KEY: dbid:hobtid (physloc) 形式のみ受付 | 常時 |
| BR-002 | NOLOCK使用 | -Row指定時はNOLOCKヒントで行データを取得 | KEY待機時 |
| BR-003 | DBCC TRACEON | DBCC PAGE実行前にトレースフラグ3604を有効化 | PAGE待機時 |

### 計算ロジック

正規表現パターン:
- PAGE: `^PAGE: [0-9]*:[0-9]*:[0-9]*$`
- KEY: `^KEY: [0-9]*:[0-9]* \([a-f0-9]*\)$`

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| ファイル情報取得 | sys.master_files | SELECT | データファイル情報 |
| オブジェクト情報取得 | sys.all_objects | SELECT | オブジェクトメタデータ |
| インデックス情報取得 | sys.partitions, sys.indexes | SELECT | インデックス情報 |
| ページ解析 | DBCC PAGE | 診断コマンド | ページヘッダー解析 |
| 行データ取得 | ユーザーテーブル | SELECT (NOLOCK) | ロック行のデータ |

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

#### sys.master_files

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| SELECT | name, physical_name | database_id=?, file_ID=? | ファイル情報取得 |

#### sys.partitions / sys.indexes / sys.all_objects

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| SELECT | object_id, schema_name, name, index_id | hobt_id=? | KEY解決用 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| FormatError | 形式エラー | WaitResourceが不正形式 | Stop-Function/return |
| ConnectionError | 接続エラー | Connect-DbaInstance失敗 | Stop-Function/Continue |
| NotFoundError | 未検出 | データベース/オブジェクトが存在しない | Warning/return |
| PageOverflowError | ページ超過 | データベース末尾を超えるページ指定 | Stop-Function/return |

### リトライ仕様

リトライ処理なし（単一試行）

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

読み取り専用クエリのためトランザクション管理不要。-Row時はNOLOCKヒント使用。

## パフォーマンス要件

- DBCC PAGEは軽量だが、対象データベースへのアクセスが必要
- -Row使用時は対象テーブルのサイズに依存

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

- VIEW SERVER STATE権限が必要
- 対象データベースへのSELECT権限が必要（-Row使用時）
- DBCC PAGE実行にはsysadmin権限推奨
- 資格情報はPSCredentialで安全に渡される

## 備考

- Stuart Moore氏(@napalmgram)による開発
- -Rowパラメータは調査目的でのみ使用推奨

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Get-DbaWaitResource.ps1 | `public/Get-DbaWaitResource.ps1` | PAGE出力構造（149-158行目）とKEY出力構造（178-186行目） |

**読解のコツ**: PAGE待機とKEY待機で出力プロパティが異なる点に注意

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Get-DbaWaitResource.ps1 | `public/Get-DbaWaitResource.ps1` | パラメータ定義とフォーマット検証（94-109行目） |

**主要処理フロー**:
1. **106行目**: 正規表現でPAGE/KEY形式を検証
2. **111-115行目**: Connect-DbaInstanceで接続
3. **117-124行目**: リソースタイプとDB ID抽出、DB存在確認

#### Step 3: PAGE処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Get-DbaWaitResource.ps1 | `public/Get-DbaWaitResource.ps1` | PAGE処理ブロック（125-159行目） |

**主要処理フロー**:
- **126行目**: 正規表現でファイルIDとページIDを抽出
- **127-128行目**: sys.master_filesからファイル情報取得
- **133行目**: DBCC TRACEON (3604) + DBCC PAGE実行
- **135行目**: TABLERESULTS出力からObjectIdを抽出
- **144-145行目**: sys.all_objectsからオブジェクト情報取得

#### Step 4: KEY処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | Get-DbaWaitResource.ps1 | `public/Get-DbaWaitResource.ps1` | KEY処理ブロック（160-199行目） |

**主要処理フロー**:
- **161行目**: 正規表現でHoBT IDとphysloc抽出
- **162-172行目**: sys.partitions/indexes/all_objectsからインデックス情報取得
- **187-195行目**: -Row指定時は%%lockres%%で行データ取得

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

```
Get-DbaWaitResource
    │
    ├─ 正規表現マッチング
    │      └─ PAGE/KEY形式検証
    │
    ├─ Connect-DbaInstance
    │      └─ SMO接続の確立
    │
    ├─ [PAGE処理]
    │      ├─ sys.master_filesクエリ
    │      ├─ DBCC TRACEON (3604)
    │      ├─ DBCC PAGE (WITH TABLERESULTS)
    │      └─ sys.all_objectsクエリ
    │
    └─ [KEY処理]
           ├─ sys.partitions/indexes/all_objectsクエリ
           └─ %%lockres%%による行データ取得（-Row時）
```

### データフロー図

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

WaitResource ──────▶ 正規表現マッチ ──────┐
(PAGE/KEY文字列)                          │
                                          ▼
SqlInstance ──────▶ Connect-DbaInstance ──┤
                                          │
                          ┌───────────────┴───────────────┐
                          ▼                               ▼
                    [PAGE処理]                       [KEY処理]
                          │                               │
                          ▼                               ▼
               sys.master_files              sys.partitions/indexes
                          │                               │
                          ▼                               │
                    DBCC PAGE                             │
                          │                               │
                          ▼                               ▼
               sys.all_objects                    PSCustomObject
                          │                               │
                          ▼                               │(-Row時)
                   PSCustomObject ◀─────────────────┬─────┤
                          │                         │     ▼
                          │                         │ %%lockres%%
                          │                         │     │
                          ▼                         ▼     ▼
                   パイプライン出力 ◀───────── ObjectData追加
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Get-DbaWaitResource.ps1 | `public/Get-DbaWaitResource.ps1` | ソース | メイン関数実装 |
| Connect-DbaInstance.ps1 | `public/Connect-DbaInstance.ps1` | ソース | SQL Server接続処理 |
