# 機能設計書 243-Test-DbaDbCompatibility

## 概要

本ドキュメントは、SQL Serverインスタンスがサポートする最大互換性レベルよりも低い互換性レベルで実行されているデータベースを特定する機能 `Test-DbaDbCompatibility` の設計仕様を記載する。

### 本機能の処理概要

この機能は、各データベースの互換性レベルをSQL Serverインスタンスの最大サポート互換性レベルと比較する。インスタンスアップグレード後に利用可能になった新しいSQL Server機能やパフォーマンス改善を活用できていないデータベースを特定するのに役立つ。

**業務上の目的・背景**：SQL Serverのアップグレード後、データベースは自動的に互換性レベルが更新されないため、新機能（クエリオプティマイザの改善、新しいT-SQL構文など）を利用できない場合がある。本機能により、互換性レベルの更新が必要なデータベースを特定し、最適なパフォーマンスとSQL Serverの最新機能の活用を促進する。

**機能の利用シーン**：
- SQL Serverインスタンスアップグレード後の互換性レベル監査
- 新機能利用可否の事前評価
- データベース標準化の一環としての互換性レベル統一
- パフォーマンスチューニングのための事前診断

**主要な処理内容**：
1. 指定されたSQL Serverインスタンスに接続（SQL Server 2008以上）
2. サーバーのバージョンメジャーから最大互換性レベルを算出
3. 各データベースの現在の互換性レベルを取得
4. サーバーの最大互換性レベルとの比較結果を出力

**関連システム・外部連携**：SQL Server SMO（CompatibilityLevel列挙型）を使用。

**権限による制御**：データベースへのアクセス権限が必要。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 27 | データベース互換性 | 補助機能 | データベース互換性のテスト |

## 機能種別

バリデーション / 診断処理

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | Yes | ターゲットSQL Serverインスタンス | SQL Server 2008以上（MinimumVersion 10） |
| SqlCredential | PSCredential | No | 代替資格情報 | 有効なPowerShell資格情報 |
| Database | object[] | No | チェック対象データベース | ワイルドカード対応 |
| ExcludeDatabase | object[] | No | 除外するデータベース | ワイルドカード対応 |
| EnableException | switch | No | 例外のスロー有効化 | - |

### 入力データソース

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

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | SQL Serverインスタンスのコンピュータ名 |
| InstanceName | string | SQL Serverインスタンス名 |
| SqlInstance | string | 完全なSQL Serverインスタンス名（computer\instance） |
| ServerLevel | CompatibilityLevel | SQL Serverインスタンスの互換性レベル |
| Database | string | 評価対象のデータベース名 |
| DatabaseCompatibility | CompatibilityLevel | データベースの現在の互換性レベル |
| IsEqual | bool | データベース互換性レベルがサーバーの最大互換性レベルと一致するか |

### 出力先

- PowerShellパイプライン出力（PSCustomObject）

## 処理フロー

### 処理シーケンス

```
1. 各SqlInstanceに対してループ処理
   └─ Connect-DbaInstance（MinimumVersion 10）で接続
2. サーバーの最大互換性レベルを算出
   └─ Version{VersionMajor}0 形式で構築
3. Databaseパラメータでフィルタリング
   └─ 指定されたデータベースのみに絞り込み
4. ExcludeDatabaseパラメータで除外
   └─ 指定されたデータベースを除外
5. 各データベースに対して互換性レベル比較
   └─ サーバー互換性レベルとデータベース互換性レベルを比較
6. 結果オブジェクトを出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{各インスタンスをループ}
    B --> C[Connect-DbaInstance MinimumVersion 10]
    C --> D{接続成功?}
    D -->|No| E[Stop-Function]
    E --> B
    D -->|Yes| F[サーバー互換性レベル算出]
    F --> G[全データベース取得]
    G --> H{Databaseフィルタ?}
    H -->|Yes| I[指定DBでフィルタ]
    H -->|No| J{ExcludeDatabase?}
    I --> J
    J -->|Yes| K[指定DBを除外]
    J -->|No| L{各DBをループ}
    K --> L
    L --> M[互換性レベル比較]
    M --> N[結果出力]
    N --> L
    L -->|完了| B
    B -->|完了| O[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-243-1 | 互換性レベル算出 | サーバーのVersionMajorから最大互換性レベルを算出 | 常時 |
| BR-243-2 | 互換性レベル一致判定 | データベース互換性レベルがサーバー互換性レベルと一致するか判定 | 各データベースに対して |

### 計算ロジック

サーバー互換性レベル算出：
```powershell
$serverVersion = $server.VersionMajor
$serverLevel = [Microsoft.SqlServer.Management.Smo.CompatibilityLevel]"Version$($serverVersion)0"
```

互換性レベル一致判定：
```powershell
IsEqual = $db.CompatibilityLevel -eq $serverLevel
```

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| 互換性レベル取得 | SMO Server/Database | SELECT | サーバーとデータベースの互換性レベルプロパティを取得 |

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

#### SMOオブジェクト

| 操作 | 項目（プロパティ名） | 取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| SELECT | $server.VersionMajor | - | サーバーのメジャーバージョン |
| SELECT | $db.CompatibilityLevel | - | データベースの互換性レベル |

## エラー処理

### エラーケース一覧

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

### リトライ仕様

リトライ処理なし。各インスタンスに対してContinueでループを継続。

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

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

## パフォーマンス要件

- SMOオブジェクトのプロパティ参照のため、軽量な操作
- データベース数に応じて処理時間が増加

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

- SQL Server認証、Windows認証、Active Directory認証をサポート
- データベースへのアクセス権限が必要
- MFAサポートが必要な場合はConnect-DbaInstanceの事前使用を推奨

## 備考

- Central Management Server（CMS）からのパイプライン入力をサポート
- 互換性レベルの更新は慎重に行う必要がある（アプリケーションの動作に影響する可能性）
- SQL Server 2008以上が必要（MinimumVersion 10）

---

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

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

### 推奨読解順序

#### Step 1: コマンド構造を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Test-DbaDbCompatibility.ps1 | `public/Test-DbaDbCompatibility.ps1` | パラメータ定義、コメントベースヘルプ |

**読解のコツ**: OutputType属性とCompatibilityLevel列挙型の使用に注目。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Test-DbaDbCompatibility.ps1 | `public/Test-DbaDbCompatibility.ps1` | processブロックでの処理フロー |

**主要処理フロー**:
1. **89-94行目**: インスタンスへの接続処理（MinimumVersion 10）
2. **96-97行目**: サーバー互換性レベルの算出
3. **100-106行目**: Database/ExcludeDatabaseによるフィルタリング
4. **108-119行目**: 各データベースの互換性レベル比較と結果出力

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

```
Test-DbaDbCompatibility
    │
    ├─ Connect-DbaInstance
    │      └─ SQL Server SMO接続（MinimumVersion 10）
    │
    ├─ CompatibilityLevel列挙型
    │      └─ Version{VersionMajor}0 形式
    │
    ├─ $server.Databases
    │      └─ SMO Database コレクション
    │
    └─ PSCustomObject出力
           └─ 互換性レベル比較結果
```

### データフロー図

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

SqlInstance    ───▶ Connect-DbaInstance ───▶ $server
                           │
                           ▼
                    VersionMajor取得 ───▶ $serverLevel
                           │
                           ▼
                    $server.Databases ───▶ $dbs
                           │
                           ▼
                    フィルタリング ───▶ 対象DBリスト
                           │
                           ▼
                    互換性レベル比較 ───▶ PSCustomObject
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Test-DbaDbCompatibility.ps1 | `public/Test-DbaDbCompatibility.ps1` | ソース | メイン機能実装 |
| Connect-DbaInstance.ps1 | `public/Connect-DbaInstance.ps1` | ソース | SQL Server接続処理 |
