# 機能設計書 242-Test-DbaDbCollation

## 概要

本ドキュメントは、SQL Serverインスタンスのデフォルト照合順序と異なる照合順序を持つデータベースを特定する機能 `Test-DbaDbCollation` の設計仕様を記載する。

### 本機能の処理概要

この機能は、各データベースの照合順序をSQL Serverインスタンスのデフォルト照合順序と比較し、不一致を特定する。データベースの照合順序の不一致は、文字列比較の問題、JOIN失敗、データベース間で作業する際のストアドプロシージャエラーの原因となる可能性がある。

**業務上の目的・背景**：データベース照合順序の一貫性監査は、マイグレーション前、統合前、または文字のソートや比較動作に関連するアプリケーション問題のトラブルシューティング時に特に重要である。照合順序の不一致は、予期しないクエリ結果やエラーを引き起こす可能性がある。

**機能の利用シーン**：
- データベースマイグレーション前の照合順序整合性チェック
- 複数データベース統合前の事前検証
- アプリケーションの文字比較問題の診断
- セキュリティ・コンプライアンス監査

**主要な処理内容**：
1. 指定されたSQL Serverインスタンスに接続
2. アクセス可能なデータベース一覧を取得
3. 各データベースの照合順序とサーバーのデフォルト照合順序を比較
4. 比較結果を含むオブジェクトを出力

**関連システム・外部連携**：SQL Server SMOを使用してデータベースおよびサーバープロパティにアクセス。

**権限による制御**：データベースへのアクセス権限が必要。IsAccessibleプロパティでアクセス可否を判定。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | - | - | 画面機能マッピングに該当なし |

## 機能種別

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

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | Yes | ターゲットSQL Serverインスタンス | パイプライン入力可 |
| 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） |
| Database | string | テスト対象のデータベース名 |
| ServerCollation | string | SQL Serverインスタンスのデフォルト照合順序 |
| DatabaseCollation | string | データベースの照合順序設定 |
| IsEqual | bool | データベースの照合順序がサーバーのデフォルトと一致するか |

### 出力先

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

## 処理フロー

### 処理シーケンス

```
1. 各SqlInstanceに対してループ処理
   └─ Connect-DbaInstanceで接続
2. アクセス可能なデータベースを取得
   └─ $server.Databases | Where-Object IsAccessible
3. Databaseパラメータでフィルタリング
   └─ 指定されたデータベースのみに絞り込み
4. ExcludeDatabaseパラメータで除外
   └─ 指定されたデータベースを除外
5. 各データベースに対して照合順序比較
   └─ サーバー照合順序とデータベース照合順序を比較
6. 結果オブジェクトを出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{各インスタンスをループ}
    B --> C[Connect-DbaInstance]
    C --> D{接続成功?}
    D -->|No| E[Stop-Function]
    E --> B
    D -->|Yes| F[アクセス可能なDB取得]
    F --> G{Databaseフィルタ?}
    G -->|Yes| H[指定DBでフィルタ]
    G -->|No| I{ExcludeDatabase?}
    H --> I
    I -->|Yes| J[指定DBを除外]
    I -->|No| K{各DBをループ}
    J --> K
    K --> L[照合順序比較]
    L --> M[結果出力]
    M --> K
    K -->|完了| B
    B -->|完了| N[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-242-1 | 照合順序一致判定 | データベース照合順序がサーバー照合順序と一致するか判定 | 各データベースに対して |
| BR-242-2 | アクセス可能性チェック | IsAccessible = trueのデータベースのみ処理 | 常時 |

### 計算ロジック

照合順序一致判定：
```powershell
IsEqual = $db.collation -eq $server.collation
```

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

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

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

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

#### SMOオブジェクト

| 操作 | 項目（プロパティ名） | 取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| SELECT | $server.Collation | - | サーバーのデフォルト照合順序 |
| SELECT | $db.Collation | IsAccessible = true | データベースの照合順序 |

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

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

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

## パフォーマンス要件

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

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

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

## 備考

- Central Management Server（CMS）からのパイプライン入力をサポート
- 照合順序の不一致は意図的な場合もあるため、結果の解釈は運用コンテキストに依存

---

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

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

### 推奨読解順序

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

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

**読解のコツ**: processブロックに主要ロジックが集中している。

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

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

**主要処理フロー**:
1. **88-93行目**: インスタンスへの接続処理
2. **95行目**: アクセス可能なデータベースの取得
3. **97-103行目**: Database/ExcludeDatabaseによるフィルタリング
4. **105-116行目**: 各データベースの照合順序比較と結果出力

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

```
Test-DbaDbCollation
    │
    ├─ Connect-DbaInstance
    │      └─ SQL Server SMO接続
    │
    ├─ $server.Databases
    │      └─ SMO Database コレクション
    │
    └─ PSCustomObject出力
           └─ 照合順序比較結果
```

### データフロー図

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

SqlInstance    ───▶ Connect-DbaInstance ───▶ $server
                           │
                           ▼
                    $server.Databases ───▶ $dbs
                           │
                           ▼
                    フィルタリング ───▶ 対象DBリスト
                           │
                           ▼
                    照合順序比較 ───▶ PSCustomObject
```

### 関連ファイル一覧

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