# 機能設計書 408-Get-DbaMaxMemory

## 概要

本ドキュメントは、SQL Serverの最大サーバーメモリ設定と物理サーバーメモリ総量を取得し比較する`Get-DbaMaxMemory`機能について記述する。

### 本機能の処理概要

**業務上の目的・背景**：SQL Serverの'Max Server Memory'設定は、インスタンスが使用できるメモリの上限を制御する重要な構成パラメータである。不適切な設定は、SQL Serverのパフォーマンス低下やOSのメモリ圧迫を引き起こす。特に、デフォルト値（2147483647 MB）のままの場合、SQL Serverが利用可能な全メモリを消費する可能性がある。本機能は、設定値と物理メモリを比較することで、メモリ設定の監査やトラブルシューティングを支援する。

**機能の利用シーン**：
- 環境全体のメモリ設定監査時
- メモリ圧迫に関連するパフォーマンス問題のトラブルシューティング時
- デフォルト最大メモリ設定のインスタンス検出時
- キャパシティプランニングの検証時

**主要な処理内容**：
1. 指定されたSQL Serverインスタンスへの接続確立
2. サーバーの物理メモリ総量をPhysicalMemoryプロパティから取得
3. Max Server Memory設定値をConfiguration.MaxServerMemory.ConfigValueから取得
4. メモリ値（MB単位）と比較用情報を含むオブジェクトの出力

**関連システム・外部連携**：SQL Server Management Objects (SMO)を使用してサーバー情報を取得。外部システムとの連携はない。

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

## 関連画面

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

## 機能種別

データ取得（構成情報）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | Yes | 対象のSQL Serverインスタンス | DbaInstanceParameter型による検証 |
| SqlCredential | PSCredential | No | SQL Server認証用の資格情報 | PowerShell資格情報オブジェクト |
| EnableException | switch | No | 例外処理を有効化 | - |

### 入力データソース

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

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | SQL Serverインスタンスのコンピュータ名 |
| InstanceName | string | SQL Serverインスタンス名 |
| SqlInstance | string | 完全修飾SQL Serverインスタンス名（computer\instance形式） |
| Total | int | サーバーの物理メモリ総量（MB） |
| MaxValue | int | 設定されているMax Server Memory値（MB） |
| Server | SMO Server | SMO Serverオブジェクト（パイプライン用、非表示プロパティ） |

### 出力先

PowerShellパイプライン（PSCustomObject）

## 処理フロー

### 処理シーケンス

```
1. パラメータ検証
   └─ SqlInstance必須チェック

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

3. メモリ情報取得
   └─ $server.PhysicalMemoryから物理メモリ取得
   └─ メモリ値の端数調整（1024の倍数に）
   └─ $server.Configuration.MaxServerMemory.ConfigValueから設定値取得

4. 結果オブジェクト出力
   └─ Select-DefaultViewで表示プロパティ設定（Serverを非表示）
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[SqlInstanceパラメータ取得]
    B --> C{各インスタンスでループ}
    C --> D[Connect-DbaInstance]
    D --> E{接続成功?}
    E -->|No| F[Stop-Function -Continue]
    F --> C
    E -->|Yes| G[PhysicalMemory取得]
    G --> H{1024の倍数?}
    H -->|No| I[+1で調整]
    H -->|Yes| J[MaxServerMemory取得]
    I --> J
    J --> K[PSCustomObject生成]
    K --> L[Select-DefaultView]
    L --> M[パイプライン出力]
    M --> C
    C -->|ループ終了| N[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | メモリ端数調整 | 物理メモリが1024の倍数でない場合+1で調整 | 一部サーバーの過少報告対応 |
| BR-002 | MB単位出力 | TotalとMaxValueはMB単位で出力 | 常時適用 |
| BR-003 | デフォルト値検出 | MaxValue > Totalの場合はデフォルト設定の可能性 | パイプライン処理で検出可能 |

### 計算ロジック

- 端数調整: `if (($totalMemory % 1024) -ne 0) { $totalMemory = $totalMemory + 1 }`

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

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

| 操作 | 対象 | 操作種別 | 概要 |
|-----|------|---------|------|
| メモリ取得 | SMO Server | プロパティ参照 | PhysicalMemory、Configuration.MaxServerMemory取得 |

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

直接的なテーブル操作なし（SMO経由でのプロパティ参照）。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ConnectionError | SQL Serverへの接続失敗 | Stop-Functionで処理継続 |

### リトライ仕様

自動リトライなし。

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

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

## パフォーマンス要件

- 各インスタンスに対する実行時間：通常1秒未満
- SMOプロパティ参照のため軽量

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

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

## 備考

- Serverプロパティにより、結果をSet-DbaMaxMemoryにパイプライン渡し可能
- Get-DbaRegServerと組み合わせてCMS配下の全インスタンスを監査可能
- Find-DbaInstanceでローカルホストのインスタンスを検出して一括監査可能

---

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

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

### 推奨読解順序

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

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

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

**読解のコツ**: Serverプロパティは非接続オブジェクトのパイプライン渡しを可能にする。

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

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

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

**主要処理フロー**:
1. **71-77行目**: パラメータ定義
2. **73行目**: SqlInstanceはパイプライン入力対応

#### Step 3: メモリ取得処理を理解する

SMOからのメモリ情報取得ロジック。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Get-DbaMaxMemory.ps1 | `public/Get-DbaMaxMemory.ps1` | 87-92行目のメモリ取得処理 |

**主要処理フロー**:
- **87行目**: $server.PhysicalMemoryから物理メモリ取得
- **89-91行目**: 端数調整処理
- **99行目**: Configuration.MaxServerMemory.ConfigValueから設定値取得

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

```
Get-DbaMaxMemory
    │
    ├─ Connect-DbaInstance (内部関数)
    │      └─ SQL Server接続確立
    │
    └─ SMO Server プロパティ参照
           ├─ PhysicalMemory
           └─ Configuration.MaxServerMemory.ConfigValue
```

### データフロー図

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

SqlInstance ───────────▶ Connect-DbaInstance ──────▶ $server
                                 │
SqlCredential ───────────────────┘
                                 │
                                 ▼
                         PhysicalMemory取得
                                 │
                                 ▼
                         端数調整（1024倍数）
                                 │
                                 ▼
                         MaxServerMemory取得
                                 │
                                 ▼
                         PSCustomObject生成 ────────▶ パイプライン出力
                         (ComputerName, InstanceName,
                          SqlInstance, Total,
                          MaxValue, Server)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Get-DbaMaxMemory.ps1 | `public/Get-DbaMaxMemory.ps1` | ソース | メイン機能実装 |
| Get-DbaMaxMemory.Tests.ps1 | `tests/Get-DbaMaxMemory.Tests.ps1` | テスト | Pesterユニットテスト |
| Set-DbaMaxMemory.ps1 | `public/Set-DbaMaxMemory.ps1` | ソース | メモリ設定変更（関連機能） |
| Test-DbaMaxMemory.ps1 | `public/Test-DbaMaxMemory.ps1` | ソース | 推奨設定計算（関連機能） |
