# 機能設計書 67-Get-DbaDbccMemoryStatus

## 概要

本ドキュメントは、dbatools PowerShellモジュールにおける `Get-DbaDbccMemoryStatus` コマンドレットの機能設計書です。DBCC MEMORYSTATUSコマンドを実行し、SQL Serverのメモリ使用状況を構造化された形式で返す機能について、その仕様と実装詳細を記述します。

### 本機能の処理概要

`Get-DbaDbccMemoryStatus` は、SQL ServerのDBCC MEMORYSTATUSコマンドを実行し、出力を解析して構造化されたPowerShellオブジェクトとして返すコマンドレットです。メモリトラブルシューティングや監視を大幅に簡素化します。

**業務上の目的・背景**：SQL Serverのメモリ問題を診断する際、DBCC MEMORYSTATUSは非常に有用なコマンドですが、その出力は複数のセクションに分かれた生のテキスト形式であり、解析が困難です。本機能は、この出力を自動的にパースし、構造化されたオブジェクトとして提供することで、メモリ使用パターンの分析、メモリプレッシャーの診断、環境間の比較を容易にします。

**機能の利用シーン**：
- メモリプレッシャーの診断
- メモリ割り当てパターンの理解
- 環境間のメモリ使用量比較
- パフォーマンストラブルシューティング
- 定期的なメモリ監視の自動化

**主要な処理内容**：
1. SQL Serverインスタンスへの接続
2. DBCC MEMORYSTATUSの実行
3. 複数のレコードセットの解析
4. 各メトリクスを構造化オブジェクトとして出力

**関連システム・外部連携**：
- SQL Server インスタンス

**権限による制御**：
- DBCC MEMORYSTATUSの実行にはVIEW SERVER STATE権限が必要

## 関連画面

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

## 機能種別

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

## 入力仕様

### 入力パラメータ

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

### 入力データソース

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

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | SQL Serverのコンピュータ名 |
| InstanceName | string | SQL Serverインスタンス名（サービス名） |
| SqlInstance | string | 完全なSQL Server名（DomainInstanceName） |
| RecordSet | int | レコードセット番号（セクション識別） |
| RowId | int | 全体通しの行ID |
| RecordSetId | int | レコードセット内の行ID |
| Type | string | メモリカテゴリ/タイプ（Memory Manager, Buffer Manager等） |
| Name | string | メモリメトリクス名 |
| Value | object | メトリクス値（通常KB単位） |
| ValueType | string | 値の分類を示す列名 |

### 出力先

PowerShellパイプライン（PSCustomObject）

## 処理フロー

### 処理シーケンス

```
1. インスタンス接続
   └─ Connect-DbaInstanceでSQL Server接続
2. DBCC MEMORYSTATUS実行
   └─ server.query()で複数レコードセット取得
3. レコードセット解析
   └─ 各DataTableのヘッダーとデータを解析
4. メトリクス出力
   └─ 各行をPSCustomObjectとして出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[インスタンスループ開始]
    B --> C[Connect-DbaInstance]
    C --> D{接続成功?}
    D -->|No| E[Stop-Function]
    D -->|Yes| F[DBCC MEMORYSTATUS実行]
    F --> G{実行成功?}
    G -->|No| H[Stop-Function]
    G -->|Yes| I[レコードセットループ開始]
    I --> J[ヘッダー情報取得]
    J --> K[行ループ開始]
    K --> L[PSCustomObject生成]
    L --> M{次の行?}
    M -->|Yes| K
    M -->|No| N{次のレコードセット?}
    N -->|Yes| I
    N -->|No| O{次のインスタンス?}
    O -->|Yes| B
    O -->|No| P[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-01 | レコードセットカウント | レコードセット番号は1から開始し、各DataTableごとにインクリメント | 常時 |
| BR-02 | 行IDカウント | RowIdは全レコードセット通しで連番 | 常時 |
| BR-03 | RecordSetIdリセット | RecordSetIdは各レコードセット内でリセット | レコードセット切り替わり時 |

### 計算ロジック

該当なし

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| DBCC MEMORYSTATUS | なし | 読み取り | メモリ使用状況の取得 |

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | 接続失敗 | SQL Serverへの接続に失敗 | 接続情報を確認 |
| - | 権限不足 | VIEW SERVER STATE権限がない | 権限を付与 |
| - | DBCC実行エラー | DBCC MEMORYSTATUSの実行に失敗 | エラー詳細を確認 |

### リトライ仕様

リトライ処理なし

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

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

## パフォーマンス要件

- 軽量な診断コマンドのため、数秒以内に完了
- 出力行数はSQL Serverバージョンと構成に依存

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

- VIEW SERVER STATE権限が必要
- 読み取り専用操作のため、データへの影響なし
- メモリ情報は機密性が低いが、システム構成情報として扱う

## 備考

- DBCC MEMORYSTATUSの出力はSQL Serverバージョンによって異なる
- 参考URL: https://blogs.msdn.microsoft.com/timchapman/2012/08/16/how-to-parse-dbcc-memorystatus-via-powershell/

---

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

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

### 推奨読解順序

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

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

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

**読解のコツ**: Type（セクション名）、Name（メトリクス名）、Value（値）の組み合わせで各メトリクスを表現。

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

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

**主要処理フロー**:
1. **67-73行目**: パラメータ定義
2. **74-76行目**: begin ブロック - クエリ定義
3. **77-119行目**: process ブロック - メイン処理

#### Step 3: レコードセット解析ロジックを理解する

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

**主要処理フロー**:
- **87行目**: server.query()で複数レコードセット取得（第3引数$true）
- **89-96行目**: レコードセットとID管理
- **94-95行目**: 列ヘッダーからType/ValueType取得
- **97-111行目**: 各行のPSCustomObject生成

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

```
Get-DbaDbccMemoryStatus (public/Get-DbaDbccMemoryStatus.ps1)
    │
    ├─ Connect-DbaInstance
    │      └─ SQL Server接続
    │
    └─ server.query($query, 'master', $true)
           └─ DBCC MEMORYSTATUS
           └─ 複数DataTableを返却
```

### データフロー図

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

SqlInstance ──────▶ Connect-DbaInstance ──┐
                                          │
                                          ▼
                                   server.query()
                                   DBCC MEMORYSTATUS
                                          │
                                          ▼
                                   複数DataTable
                                          │
                              ┌───────────┼───────────┐
                              ▼           ▼           ▼
                          RecordSet1  RecordSet2  RecordSet(n)
                              │           │           │
                              └───────────┼───────────┘
                                          │
                                          ▼
                                   PSCustomObject
                              (RecordSet, Type, Name, Value)
```

### 関連ファイル一覧

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