# 機能設計書 101-Get-DbaDbCompatibility

## 概要

本ドキュメントは、SQL Serverデータベースの互換性レベルを取得するGet-DbaDbCompatibility機能の設計仕様を定義する。

### 本機能の処理概要

本機能は、SQL Serverインスタンス上のデータベースに設定されている互換性レベル（Compatibility Level）を取得し、アップグレード計画やコンプライアンス監査に活用するための情報を提供する。

**業務上の目的・背景**：SQL Serverのアップグレード後もデータベースは以前の互換性レベルを保持することがある。この機能により、どのデータベースが新しいSQL Server機能を利用できる状態にあるか、またはベンダーアプリケーションのサポート要件を満たしているかを迅速に特定できる。互換性レベルの不一致は、クエリの動作変更やパフォーマンス問題の原因となるため、計画的な管理が重要である。

**機能の利用シーン**：
- SQL Serverバージョンアップグレード前の事前調査
- アップグレード後の互換性レベル更新漏れの確認
- アプリケーションベンダー要件との整合性チェック
- 定期的なコンプライアンス監査レポートの作成

**主要な処理内容**：
1. 指定されたSQL Serverインスタンスへの接続確立
2. 対象データベースの取得（全データベースまたは指定されたデータベース）
3. 各データベースのCompatibilityLevelプロパティの読み取り
4. 標準化された形式での結果出力

**関連システム・外部連携**：SMO（SQL Server Management Objects）を使用してSQL Serverと連携する。パイプライン入力により、Get-DbaDatabaseコマンドとの連携が可能。

**権限による制御**：対象データベースへのVIEW DATABASE STATE権限、またはsysadminサーバーロールのメンバーシップが必要。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 27 | データベース互換性 | 主画面 | データベース互換性レベルの取得 |

## 機能種別

データ取得処理（SELECT相当）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | No | 対象のSQL Serverインスタンス | 有効なインスタンス名形式 |
| SqlCredential | PSCredential | No | 代替認証情報 | Windows/SQL認証、AD統合認証をサポート |
| Database | string[] | No | 対象データベース名（ワイルドカード対応） | 存在するデータベース名 |
| InputObject | Microsoft.SqlServer.Management.Smo.Database[] | No | パイプライン入力用データベースオブジェクト | SMOデータベースオブジェクト |
| EnableException | switch | No | 例外処理モードの切り替え | - |

### 入力データソース

- SqlInstance: コマンドラインパラメータまたはパイプライン入力
- Database: コマンドラインパラメータ
- InputObject: Get-DbaDatabaseコマンドなどからのパイプライン入力

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | SQL Serverをホストするコンピュータ名 |
| InstanceName | string | SQL Serverインスタンス名 |
| SqlInstance | string | 完全なSQL Serverインスタンス名（ComputerName\InstanceName形式） |
| Database | string | データベース名 |
| DatabaseId | int | データベースの内部ID |
| Compatibility | CompatibilityLevel | 互換性レベル（80=SQL2000, 90=SQL2005, 100=SQL2008, 110=SQL2012, 120=SQL2014, 130=SQL2016, 140=SQL2017, 150=SQL2019, 160=SQL2022） |

### 出力先

PowerShellパイプライン（PSCustomObject）

## 処理フロー

### 処理シーケンス

```
1. パラメータ検証
   └─ SqlInstanceまたはInputObjectのいずれかが指定されているか確認
2. データベースオブジェクトの取得
   └─ SqlInstanceが指定されている場合、Get-DbaDatabaseを呼び出し
3. データベースごとの処理ループ
   └─ 各データベースの互換性レベル情報を収集
4. 結果オブジェクトの生成と出力
   └─ PSCustomObjectとしてパイプラインに出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{SqlInstance/InputObject検証}
    B -->|どちらも未指定| C[警告メッセージ出力]
    C --> Z[終了]
    B -->|SqlInstance指定| D[Get-DbaDatabase呼び出し]
    D --> E[InputObjectに追加]
    B -->|InputObject指定| E
    E --> F{データベースループ}
    F -->|次のDB| G[サーバーバージョン取得]
    G --> H[PSCustomObject生成]
    H --> I[パイプライン出力]
    I --> F
    F -->|完了| Z
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-101 | パラメータ排他制御 | SqlInstanceまたはInputObjectのいずれかが必須 | 処理開始時 |
| BR-102 | データベースフィルタリング | Databaseパラメータでワイルドカード指定可能 | Database指定時 |

### 計算ロジック

互換性レベルはSMOのCompatibilityLevelプロパティから直接取得され、数値として返される。

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| 互換性レベル取得 | sys.databases | SELECT | SMO経由でデータベースメタデータを読み取り |

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

#### sys.databases

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| SELECT | compatibility_level | データベースごとの互換性レベル | SMO経由で取得 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | 警告 | SqlInstance/InputObjectが未指定 | パラメータを指定して再実行 |
| - | 接続エラー | SQL Serverへの接続失敗 | 接続情報を確認 |

### リトライ仕様

特になし。接続エラー時は処理を継続し、次のインスタンス/データベースを処理。

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

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

## パフォーマンス要件

SMOを使用したメタデータ読み取りのため、高速に動作。大量のデータベースがある環境でも数秒以内に完了。

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

- SqlCredentialパラメータで代替認証情報をサポート
- Windows認証、SQL Server認証、Active Directory認証に対応
- MFA使用時はConnect-DbaInstanceを事前に使用

## 備考

関連コマンド：Set-DbaDbCompatibility（互換性レベルの変更）

---

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

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

### 推奨読解順序

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

まず、出力されるPSCustomObjectの構造を理解することが重要。

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

**読解のコツ**: PowerShellのPSCustomObjectは@{}構文でハッシュテーブルからオブジェクトを生成している。各プロパティはSMOオブジェクトから取得される。

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

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Get-DbaDbCompatibility.ps1 | `public/Get-DbaDbCompatibility.ps1` | 77-84行目：パラメータ定義 |

**主要処理フロー**:
1. **86-89行目**: パラメータ検証（SqlInstanceまたはInputObjectの存在確認）
2. **91-93行目**: SqlInstance指定時のGet-DbaDatabase呼び出し
3. **95-108行目**: データベースループと結果出力

#### Step 3: 依存関数を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Get-DbaDatabase.ps1 | `public/Get-DbaDatabase.ps1` | データベースオブジェクト取得のコア処理 |

**主要処理フロー**:
- **92行目**: Get-DbaDatabase関数を呼び出してデータベースオブジェクトを取得

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

```
Get-DbaDbCompatibility
    │
    ├─ Test-Bound（パラメータ検証）
    │
    ├─ Write-Message（ログ出力）
    │
    └─ Get-DbaDatabase（SqlInstance指定時）
           └─ Connect-DbaInstance（接続確立）
```

### データフロー図

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

SqlInstance ───▶ Get-DbaDatabase ───▶ PSCustomObject
                      │                    │
Database ─────────────┘                    ├─ ComputerName
                                           ├─ InstanceName
InputObject ────────────────────────────▶  ├─ SqlInstance
                                           ├─ Database
                                           ├─ DatabaseId
                                           └─ Compatibility
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Get-DbaDbCompatibility.ps1 | `public/Get-DbaDbCompatibility.ps1` | ソース | メイン処理 |
| Get-DbaDatabase.ps1 | `public/Get-DbaDatabase.ps1` | ソース | データベースオブジェクト取得 |
| Connect-DbaInstance.ps1 | `public/Connect-DbaInstance.ps1` | ソース | SQL Server接続 |
