# 機能設計書 406-Get-DbaDbMemoryUsage

## 概要

本ドキュメントは、データベースごとおよびページタイプごとのバッファプールメモリ消費量を詳細に取得しパフォーマンス分析に活用する`Get-DbaDbMemoryUsage`機能について記述する。

### 本機能の処理概要

**業務上の目的・背景**：SQL Serverのバッファプールメモリは、パフォーマンスに直結する重要なリソースである。特定のデータベースがバッファプールの大部分を占有すると、他のデータベースやインスタンス全体のパフォーマンスに影響を与える可能性がある。本機能は、sys.dm_os_buffer_descriptorsを照会し、各データベースがどの程度のメモリを消費しているかをページタイプ（データページ、インデックスページ等）別に分析可能にする。

**機能の利用シーン**：
- メモリ圧迫のトラブルシューティング時
- データベース移行のキャパシティプランニング時
- バッファプール使用率の最適化検討時
- 特定データベースのメモリ消費量調査時

**主要な処理内容**：
1. 指定されたSQL Serverインスタンスへの接続確立
2. バッファマネージャのデータベースページ総数を取得
3. データベースごと・ページタイプごとのバッファ記述子を集計
4. メモリサイズとバッファプール使用割合を計算
5. フィルタリング（Database、ExcludeDatabase、IncludeSystemDb）を適用

**関連システム・外部連携**：SQL Serverの動的管理ビュー`sys.dm_os_buffer_descriptors`および`sys.dm_os_performance_counters`を参照する。外部システムとの連携はない。

**権限による制御**：VIEW SERVER STATE権限またはsysadminロールが必要。

## 関連画面

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

## 機能種別

データ取得（パフォーマンス監視）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstance[] | Yes | 対象のSQL Serverインスタンス | DbaInstance型による検証 |
| SqlCredential | PSCredential | No | SQL Server認証用の資格情報 | PowerShell資格情報オブジェクト |
| Database | object[] | No | 分析対象のデータベース名（複数指定可能） | データベース名またはワイルドカード |
| ExcludeDatabase | object[] | No | 除外するデータベース名（複数指定可能） | データベース名 |
| IncludeSystemDb | switch | No | システムデータベースを含める | - |
| EnableException | switch | No | 例外処理を有効化 | - |

### 入力データソース

- PowerShellコマンドライン入力
- パイプライン入力（SqlInstance、Database）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | SQL Serverインスタンスのコンピュータ名 |
| InstanceName | string | SQL Serverインスタンス名 |
| SqlInstance | string | 完全修飾SQL Serverインスタンス名 |
| Database | string | バッファプールページを消費しているデータベース名 |
| PageType | string | バッファ内のページタイプ（data pages、index pages等） |
| PageCount | int | このデータベースとページタイプに割り当てられた8KBページ数 |
| Size | DbaSize | このデータベースとページタイプが消費するメモリ量（MB） |
| PercentUsed | int | このデータベースとページタイプが消費するバッファプール全体の割合（0-100%） |

### 出力先

PowerShellパイプライン（PSCustomObject）

## 処理フロー

### 処理シーケンス

```
1. SQLクエリ準備（beginブロック）
   └─ バッファマネージャからデータベースページ総数取得
   └─ バッファ記述子の集計クエリ構築

2. 各インスタンスに対してループ処理
   └─ Connect-DbaInstanceによる接続確立（MinimumVersion 9）
   └─ 接続失敗時はStop-Functionで継続処理

3. SQLクエリ実行
   └─ データベースID=32767はResourceDbとして処理

4. フィルタリング適用
   └─ Database指定時: 指定データベースのみ
   └─ ExcludeDatabase指定時: 指定データベースを除外
   └─ IncludeSystemDb未指定時: システムDB除外

5. 結果オブジェクト出力
   └─ PageCountは非表示プロパティとして設定
   └─ Select-DefaultViewで表示プロパティ設定
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[SQLクエリ準備]
    B --> C{各インスタンスでループ}
    C --> D[Connect-DbaInstance]
    D --> E{接続成功?}
    E -->|No| F[Stop-Function -Continue]
    F --> C
    E -->|Yes| G[SQLクエリ実行]
    G --> H{各レコードでループ}
    H --> I{Database指定?}
    I -->|Yes| J{指定DBに含まれる?}
    J -->|No| H
    J -->|Yes| K{ExcludeDatabase指定?}
    I -->|No| K
    K -->|Yes| L{除外DBに含まれる?}
    L -->|Yes| H
    L -->|No| M{IncludeSystemDb?}
    K -->|No| M
    M -->|No| N{システムDB?}
    N -->|Yes| H
    N -->|No| O[PSCustomObject生成]
    M -->|Yes| O
    O --> P[パイプライン出力]
    P --> H
    H -->|ループ終了| C
    C -->|ループ終了| Q[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | バージョン要件 | SQL Server 2005以上が必要 | 接続時に検証 |
| BR-002 | ResourceDb識別 | database_id=32767はResourceDbとして表示 | 常時適用 |
| BR-003 | システムDB定義 | master、model、msdb、tempdb、ResourceDbがシステムDB | IncludeSystemDb未指定時 |
| BR-004 | 使用率計算 | PercentUsed = (db_buffer_pages * 100.0 / @total_buffer) | 常時適用 |
| BR-005 | NULL処理 | PercentUsedがDBNullの場合は0として処理 | PercentUsedがNULL時 |

### 計算ロジック

- サイズ計算: `(db_buffer_pages * 8) / 1024` (MB)
- 使用率計算: `db_buffer_pages * 100.0 / @total_buffer`

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| 総ページ数取得 | sys.dm_os_performance_counters | SELECT | Database Pagesカウンター取得 |
| バッファ集計 | sys.dm_os_buffer_descriptors | SELECT | データベース・ページタイプ別集計 |

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

#### sys.dm_os_performance_counters

| 操作 | 項目（カラム名） | 取得条件 | 備考 |
|-----|-----------------|---------|------|
| SELECT | cntr_value | object_name LIKE '%Buffer Manager' AND counter_name = 'Database Pages' | バッファプール総ページ数 |

#### sys.dm_os_buffer_descriptors

| 操作 | 項目（カラム名） | 取得条件 | 備考 |
|-----|-----------------|---------|------|
| SELECT | database_id | GROUP BY | データベース識別 |
| SELECT | page_type | GROUP BY | ページタイプ識別 |
| SELECT | COUNT_BIG(*) | - | ページ数集計 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ConnectionError | SQL Serverへの接続失敗 | Stop-Functionで処理継続 |
| - | QueryError | SQLクエリ実行失敗 | Stop-Functionでエラーメッセージ出力 |
| - | VersionError | SQL Server 2005未満 | MinimumVersionで接続拒否 |

### リトライ仕様

自動リトライなし。

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

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

## パフォーマンス要件

- 大規模バッファプールでは集計に時間がかかる可能性あり
- フィルタリングはクエリ実行後に適用

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

- VIEW SERVER STATE権限またはsysadminロールが必要
- SqlCredentialパラメータでSQL認証を使用可能

## 備考

- Aaron Bertrandのクエリに基づいた実装
- MSSQLTipsの記事を参照
- PageCountは追加プロパティとして Select-Object * で取得可能

---

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

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

### 推奨読解順序

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

出力オブジェクトの構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Get-DbaDbMemoryUsage.ps1 | `public/Get-DbaDbMemoryUsage.ps1` | 153-162行目の出力オブジェクト定義 |

**読解のコツ**: DbaSize型でサイズを扱い、Select-DefaultViewでPageCountを非表示にしている。

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

処理の起点となる関数定義とパラメータを特定。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Get-DbaDbMemoryUsage.ps1 | `public/Get-DbaDbMemoryUsage.ps1` | 1-101行目のヘルプドキュメントとパラメータ定義 |

**主要処理フロー**:
1. **91-101行目**: パラメータ定義
2. **96-97行目**: DatabaseとExcludeDatabaseパラメータ
3. **99行目**: IncludeSystemDbスイッチ

#### Step 3: SQLクエリを理解する

バッファ記述子を集計するSQLクエリ。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Get-DbaDbMemoryUsage.ps1 | `public/Get-DbaDbMemoryUsage.ps1` | 104-121行目のbeginブロック |

**主要処理フロー**:
- **104-108行目**: @total_buffer変数への総ページ数取得
- **110-121行目**: CTEによるバッファ記述子集計クエリ

#### Step 4: フィルタリングロジックを理解する

データベースフィルタリングの適用。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | Get-DbaDbMemoryUsage.ps1 | `public/Get-DbaDbMemoryUsage.ps1` | 137-145行目のフィルタリング処理 |

**主要処理フロー**:
- **137-138行目**: Database指定時のフィルタリング
- **140-141行目**: ExcludeDatabase指定時のフィルタリング
- **143-144行目**: IncludeSystemDb未指定時のシステムDB除外

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

```
Get-DbaDbMemoryUsage
    │
    ├─ Connect-DbaInstance (内部関数)
    │      └─ SQL Server接続確立
    │
    ├─ $server.Query() (SMOメソッド)
    │      └─ バッファ集計クエリ実行
    │
    ├─ Test-Bound (内部関数)
    │      └─ パラメータ指定チェック
    │
    └─ Select-DefaultView (内部関数)
           └─ 表示プロパティ設定
```

### データフロー図

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

SqlInstance ─────────────▶ Connect-DbaInstance ──────▶ $server
                                   │
SqlCredential ─────────────────────┘
                                   │
                                   ▼
                          SQLクエリ実行
                          (バッファ集計)
                                   │
                                   ▼
Database ──────────────▶ フィルタリング処理
ExcludeDatabase ───────────────────│
IncludeSystemDb ───────────────────┘
                                   │
                                   ▼
                          PSCustomObject生成 ────────▶ パイプライン出力
                          (ComputerName, InstanceName,
                           SqlInstance, Database,
                           PageType, PageCount,
                           Size, PercentUsed)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Get-DbaDbMemoryUsage.ps1 | `public/Get-DbaDbMemoryUsage.ps1` | ソース | メイン機能実装 |
| Get-DbaDbMemoryUsage.Tests.ps1 | `tests/Get-DbaDbMemoryUsage.Tests.ps1` | テスト | Pesterユニットテスト |
