# 機能設計書 234-Show-DbaDbList

## 概要

本ドキュメントは、dbatools PowerShellモジュールのShow-DbaDbList関数に関する機能設計書です。この関数はSQL Serverインスタンスに接続し、利用可能なデータベースをインタラクティブな選択ウィンドウで表示します。

### 本機能の処理概要

**業務上の目的・背景**：データベース管理スクリプトの作成時、データベース名をハードコードする必要性を排除し、ユーザーが視覚的にデータベースを選択できるようにします。これにより、正確なデータベース名を覚える必要がなく、ユーザーフレンドリーなメンテナンススクリプトの構築が可能になります。

**機能の利用シーン**：インタラクティブなメンテナンススクリプトの構築時、エンドユーザーがSSMSなしでデータベースを選択する必要がある場合、環境によりデータベース名が異なる動的ツールの作成時、データベース選択を含むGUIベースの管理ツール開発時に使用されます。

**主要な処理内容**：
1. Windows Presentation Framework (WPF) アセンブリのロード
2. SQL Serverインスタンスへの接続
3. データベース一覧の取得
4. TreeView形式のGUIダイアログの表示
5. ユーザー選択の取得と返却

**関連システム・外部連携**：Windows Presentation Framework (WPF)、SQL Server Management Objects (SMO)を使用します。

**権限による制御**：SQL Serverへの接続権限とデータベース一覧の参照権限が必要です。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| N/A | データベース選択ダイアログ | 主画面 | TreeViewでデータベース一覧を表示 |

## 機能種別

GUI表示処理（Interactive Dialog）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter | Yes | 対象SQL Serverインスタンス | パイプライン入力対応 |
| SqlCredential | PSCredential | No | SQL Server認証用資格情報 | - |
| Title | string | No | ウィンドウタイトル（デフォルト："Select Database"） | - |
| Header | string | No | 説明テキスト（デフォルト："Select the database:"） | - |
| DefaultDb | string | No | デフォルト選択するデータベース名 | - |
| EnableException | switch | No | 例外処理の有効化 | - |

### 入力データソース

- PowerShellコマンドライン引数
- SQL Serverインスタンスからのデータベース一覧

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| - | System.String | 選択されたデータベース名 |

### 出力先

- パイプラインに文字列として出力
- キャンセル時またはOK未クリック時はnullを返却

## 処理フロー

### 処理シーケンス

```
1. WPFアセンブリのロード
   └─ PresentationFrameworkのロード確認
2. SQL Server接続
   └─ Connect-DbaInstanceで接続
3. データベース一覧取得
   └─ server.Databases.Name
4. GUIダイアログ構築
   └─ XAML定義のロードとTreeView構築
5. ダイアログ表示
   └─ ShowDialog()でモーダル表示
6. 結果返却
   └─ 選択されたデータベース名またはnull
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[WPFアセンブリロード]
    B --> C{ロード成功?}
    C -->|No| D[エラー終了]
    C -->|Yes| E[SQL Server接続]
    E --> F{接続成功?}
    F -->|No| D
    F -->|Yes| G[データベース一覧取得]
    G --> H[GUIダイアログ構築]
    H --> I[TreeViewにデータベース追加]
    I --> J[ダイアログ表示]
    J --> K{OKクリック?}
    K -->|Yes| L[選択DB名返却]
    K -->|No| M[null返却]
    L --> N[終了]
    M --> N
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | デフォルト選択 | DefaultDb指定時は該当DBを事前選択 | DefaultDb指定時 |
| BR-002 | キャンセル動作 | キャンセル時はnullを返却 | キャンセルボタン押下時 |
| BR-003 | OK動作 | OK押下時のみ選択値を返却 | OKボタン押下時 |
| BR-004 | WPF必須 | Windows Presentation Frameworkが必要 | 常時 |

### 計算ロジック

特になし

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| データベース一覧取得 | sys.databases | SELECT | SMO経由でデータベース名を取得 |

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

#### sys.databases（参照・SMO経由）

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| SELECT | name | 全データベース | server.Databases.Name経由 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| WPFLoadError | アセンブリエラー | WPFがインストールされていない | Windows環境で実行 |
| ConnectionError | 接続エラー | SQL Server接続失敗 | インスタンス名・認証情報確認 |

### リトライ仕様

リトライ処理は実装されていません。

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

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

## パフォーマンス要件

- データベース一覧取得は即時
- GUI表示はユーザー操作待ち

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

- SQL Server接続にはView any database権限または個別のデータベースアクセス権限が必要
- SqlCredential使用時はSecureStringで資格情報を保護

## 備考

- Windows環境（WPF対応）でのみ動作
- PowerShell CoreではWPFが利用できない場合があります

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Show-DbaDbList.ps1 | `public/Show-DbaDbList.ps1` | パラメータ定義（76-84行目） |

**読解のコツ**: WPFのTreeViewItemやStackPanel等、GUI要素の構造を理解することが重要です。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Show-DbaDbList.ps1 | `public/Show-DbaDbList.ps1` | begin block - WPFアセンブリロードとヘルパー関数定義（86-141行目） |

**主要処理フロー**:
1. **87-92行目**: WPF PresentationFrameworkアセンブリのロード
2. **94-124行目**: Add-TreeItem関数 - TreeViewにアイテムを追加
3. **126-135行目**: Convert-b64toimg関数 - Base64画像変換
4. **137-139行目**: アイコン画像のデコード

#### Step 3: メイン処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Show-DbaDbList.ps1 | `public/Show-DbaDbList.ps1` | process block - SQL接続とGUI構築（143-225行目） |

**主要処理フロー**:
- **146-151行目**: SQL Server接続
- **154-168行目**: XAML定義のロード
- **171-193行目**: TreeViewルートアイテムの構築
- **195-203行目**: データベース一覧の取得とアイテム追加
- **205-222行目**: イベントハンドラ設定（OK/Cancelボタン、選択変更）
- **224行目**: ShowDialog()でモーダル表示

#### Step 4: 出力処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | Show-DbaDbList.ps1 | `public/Show-DbaDbList.ps1` | end block - 結果返却（227-231行目） |

**主要処理フロー**:
- **228-230行目**: OKボタン押下かつ選択がある場合のみ値を返却

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

```
Show-DbaDbList
    │
    ├─ Add-Type (PresentationFramework)
    │      └─ WPFアセンブリロード
    │
    ├─ Connect-DbaInstance
    │      └─ SQL Server接続確立
    │
    ├─ server.Databases.Name
    │      └─ データベース一覧取得
    │
    ├─ XamlReader.Load
    │      └─ XAML→WPFオブジェクト変換
    │
    ├─ Add-TreeItem (内部関数)
    │      └─ TreeViewにデータベース追加
    │
    └─ window.ShowDialog()
           └─ モーダルダイアログ表示
```

### データフロー図

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

SqlInstance ──────┐
                  │
SqlCredential ────┼──▶ Show-DbaDbList ─────────────────▶ System.String
                  │         │                              (選択DB名 or null)
Title ────────────┤         ├─ Connect-DbaInstance
                  │         ├─ Get Databases
Header ───────────┤         ├─ Build WPF Dialog
                  │         └─ Show Dialog
DefaultDb ────────┘

[SQL Server] ◄───── SMO Query ─────┘
(sys.databases)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Show-DbaDbList.ps1 | `public/Show-DbaDbList.ps1` | ソース | メイン関数実装 |
| Connect-DbaInstance.ps1 | `public/Connect-DbaInstance.ps1` | ソース | SQL Server接続ヘルパー |
| Test-FunctionInterrupt.ps1 | `private/functions/Test-FunctionInterrupt.ps1` | ソース | 割り込み確認ヘルパー |
| Stop-Function.ps1 | `private/functions/Stop-Function.ps1` | ソース | エラー処理ヘルパー |
