# 画面設計書 155-待機リソース

## 概要

本ドキュメントは、dbatools PowerShellモジュールにおける待機リソース解析機能の設計を定義する。sys.dm_exec_requestsから取得される暗号的な待機リソース文字列を、人間が理解できるデータベースオブジェクト情報に変換する。

### 本画面の処理概要

本機能は、ブロッキングやデッドロックの調査時に表示される「PAGE: 10:1:9180084」や「KEY: 7:35457594073541168 (de21f92a1572)」といった待機リソース識別子を、実際のデータベース名、スキーマ名、テーブル名、インデックス名に変換する。

**業務上の目的・背景**：ブロッキングチェーンやデッドロックの調査時、DMVに表示されるwait_resource値は暗号的で直接的な意味がわからない。本機能は、手動でDBCC PAGEを実行したり、システムカタログを照会したりする手間を省き、待機リソースの正体を即座に特定できる。これにより、どのテーブルやインデックスで競合が発生しているかを迅速に把握でき、本番環境でのトラブルシューティング時間を大幅に短縮できる。

**画面へのアクセス方法**：PowerShellコンソールまたはスクリプトから以下のコマンドを実行してアクセスする：
- `Get-DbaWaitResource -SqlInstance <インスタンス名> -WaitResource <待機リソース文字列>`

**主要な操作・処理内容**：
1. 待機リソース文字列のフォーマット検証（PAGE: または KEY:）
2. PAGE待機リソースの場合：DBCC PAGEでオブジェクト情報を取得
3. KEY待機リソースの場合：sys.partitionsとsys.indexesからインデックス情報を取得
4. オプションで実際のロック行データを取得（-Row）
5. データベース名、スキーマ名、オブジェクト名、インデックス名の出力

**画面遷移**：
- 本機能はスタンドアロンで動作し、他の機能への直接的な画面遷移はない
- パイプラインでGet-DbaWaitingTaskからの出力を受け取り可能

**権限による表示制御**：
- SQL Server接続権限が必要
- DBCC PAGE実行にはsysadmin権限または該当データベースのdb_owner権限が必要

## 関連機能

| 機能No | 機能名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 413 | Get-DbaWaitResource | 主機能 | 待機リソース文字列の解析と変換 |

## 画面種別

詳細 / 診断情報表示

## URL/ルーティング

PowerShellコマンドレット:
- `Get-DbaWaitResource`

## 入出力項目

### Get-DbaWaitResource パラメータ

| パラメータ名 | 型 | 必須 | 説明 |
|-------------|------|------|------|
| SqlInstance | DbaInstance | Yes | 接続先SQL Serverインスタンス |
| SqlCredential | PSCredential | No | SQL Server認証用資格情報 |
| WaitResource | string | Yes | 待機リソース文字列（PAGE: または KEY:形式） |
| Row | switch | No | ロック行のデータも取得 |
| EnableException | switch | No | 例外処理の有効化 |

## 表示項目

### PAGE待機リソース出力プロパティ

| プロパティ名 | 型 | 説明 |
|-------------|------|------|
| DatabaseID | int | 待機リソースのデータベースID |
| DatabaseName | string | データベース名 |
| DataFileName | string | データファイルの論理名 |
| DataFilePath | string | データファイルの物理パス |
| ObjectID | int | オブジェクトID |
| ObjectName | string | テーブルまたはインデックス名 |
| ObjectSchema | string | スキーマ名 |
| ObjectType | string | オブジェクトタイプ（USER_TABLE等） |

### KEY待機リソース出力プロパティ

| プロパティ名 | 型 | 説明 |
|-------------|------|------|
| DatabaseID | int | 待機リソースのデータベースID |
| DatabaseName | string | データベース名 |
| SchemaName | string | スキーマ名 |
| IndexName | string | インデックス名 |
| ObjectID | int | オブジェクトID |
| ObjectName | string | テーブル名 |
| HobtID | long | HeapまたはB-Tree ID |
| ObjectData | DataRow | ロック行のデータ（-Row指定時） |

## イベント仕様

### 1-PAGE待機リソース解析

1. 正規表現でPAGE形式（PAGE: dbid:fileid:pageid）を検証
2. Connect-DbaInstanceでSQL Serverインスタンスに接続
3. sys.master_filesからデータファイル情報を取得
4. DBCC TRACEON (3604) と DBCC PAGE を実行
5. Metadata: ObjectId フィールドからオブジェクトIDを抽出
6. sys.all_objectsからオブジェクト名とスキーマ名を取得
7. 結果オブジェクトを構築して出力

### 2-KEY待機リソース解析

1. 正規表現でKEY形式（KEY: dbid:hobtid (physloc)）を検証
2. Connect-DbaInstanceでSQL Serverインスタンスに接続
3. sys.partitions、sys.indexes、sys.all_objectsを結合してインデックス情報を取得
4. -Rowパラメータ指定時は%%lockres%%を使用して行データを取得
5. 結果オブジェクトを構築して出力

## データベース更新仕様

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

| 操作（イベント） | 対象テーブル | 操作種別 | 概要 |
|----------------|-------------|---------|------|
| PAGE解析 | sys.master_files | SELECT | ファイル情報取得 |
| PAGE解析 | DBCC PAGE | 実行 | ページメタデータ取得 |
| PAGE解析 | sys.all_objects | SELECT | オブジェクト情報取得 |
| KEY解析 | sys.partitions | SELECT | パーティション情報取得 |
| KEY解析 | sys.indexes | SELECT | インデックス情報取得 |
| KEY解析 | sys.all_objects | SELECT | オブジェクト情報取得 |
| KEY解析（-Row） | 対象テーブル | SELECT | ロック行データ取得（NOLOCK） |

### テーブル別更新項目詳細

本機能は読み取り専用のため、データベースへの更新は発生しない。

## メッセージ仕様

| メッセージID | レベル | 条件 | メッセージ内容 |
|-------------|--------|------|---------------|
| - | Error | フォーマット不正 | "Row input - {WaitResource} - Improperly formatted" |
| - | Warning | ファイル未検出 | "Datafile with id {FileID} for {dbName} not found" |
| - | Warning | オブジェクト未検出 | "Object not found, could have been delete, or a transcription error..." |
| - | Warning | HoBT未検出 | "Heap or B-Tree with ID {frodo} can not be found in {dbName}..." |
| - | Warning | 行データ未取得 | "Could not retrieve the data. It may have been deleted or moved..." |
| - | Error | ページ範囲外 | "You've requested a page beyond the end of the database, exiting" |
| - | Error | データベース未存在 | "Database with id {dbId} does not exist on {server}" |

## 例外処理

| 例外条件 | 処理内容 |
|---------|---------|
| SQL Server接続失敗 | ConnectionError カテゴリでStop-Function実行、処理継続 |
| WaitResourceフォーマット不正 | Stop-Functionでエラー出力、処理終了 |
| データベース未存在 | Stop-Functionでエラー出力、処理終了 |
| DBCC PAGE失敗 | Stop-Functionでエラー出力、処理終了 |

## 備考

- PAGEフォーマット: PAGE: dbid:fileid:pageid（例: PAGE: 10:1:9180084）
- KEYフォーマット: KEY: dbid:hobtid (physloc)（例: KEY: 7:35457594073541168 (de21f92a1572)）
- -Rowオプションは%%lockres%%関数を使用してロック行を特定
- NOLOCKヒントを使用して安全に行データを取得
- オブジェクトが削除されている場合は警告を出力

---

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

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

### 推奨読解順序

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

待機リソース解析結果のデータ構造を理解する。

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

**読解のコツ**: PAGE解析とKEY解析で異なる出力構造を持つことに注意。

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

処理の起点となるコマンドレット関数を特定。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Get-DbaWaitResource.ps1 | `public/Get-DbaWaitResource.ps1` | 94-103行目: param()ブロックでパラメータ定義を確認 |

**主要処理フロー**:
1. **106-109行目**: 正規表現でフォーマット検証
2. **111-115行目**: Connect-DbaInstanceでSQL Server接続
3. **117-124行目**: データベースIDとリソースタイプ抽出
4. **125-159行目**: PAGE解析処理
5. **160-199行目**: KEY解析処理

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Get-DbaWaitResource.ps1 | `public/Get-DbaWaitResource.ps1` | 125-159行目: PAGE解析処理全体 |

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

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | Get-DbaWaitResource.ps1 | `public/Get-DbaWaitResource.ps1` | 160-199行目: KEY解析処理全体 |

**主要処理フロー**:
- **161行目**: 正規表現でhobtid, physlocを抽出
- **162-172行目**: sys.partitions、sys.indexes結合クエリ
- **187-189行目**: -Row指定時の%%lockres%%クエリ

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

```
Get-DbaWaitResource
    |
    +-- 正規表現検証
    |       +-- PAGE: dbid:fileid:pageid
    |       +-- KEY: dbid:hobtid (physloc)
    |
    +-- Connect-DbaInstance
    |       +-- SMO Server Object生成
    |
    +-- [PAGE解析]
    |       +-- Server.Query() -> sys.master_files
    |       +-- Database.Query() -> DBCC TRACEON, DBCC PAGE
    |       +-- Database.Query() -> sys.all_objects
    |
    +-- [KEY解析]
            +-- Database.Query() -> sys.partitions + sys.indexes
            +-- [-Row] Database.Query() -> %%lockres%% WHERE
```

### データフロー図

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

WaitResource   ------>  正規表現マッチ  ----+
  "PAGE: 10:1:9180084"         |            |
  "KEY: 7:..."                 |            |
                               v            |
                        リソースタイプ判定   |
                               |            |
            +------------------+            |
            |                               |
            v                               v
    [PAGE解析]                      [KEY解析]
         |                               |
         v                               v
    DBCC PAGE実行               sys.partitions照会
         |                               |
         v                               v
    ObjectId抽出                 HoBT -> Index情報
         |                               |
         v                               v
    sys.all_objects             [-Row] %%lockres%%
         |                               |
         v                               v
    PSCustomObject              PSCustomObject
    (PAGE Properties)           (KEY Properties)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Get-DbaWaitResource.ps1 | `public/Get-DbaWaitResource.ps1` | ソース | 待機リソース解析の主処理 |
| Connect-DbaInstance.ps1 | `public/Connect-DbaInstance.ps1` | ソース | SQL Server接続処理 |
