# 機能設計書 11-Get-DbaAgDatabase

## 概要

本ドキュメントは、SQL Server可用性グループに参加しているデータベースの情報と同期状態を取得するGet-DbaAgDatabaseコマンドの機能設計書です。

### 本機能の処理概要

Get-DbaAgDatabaseは、SQL Server可用性グループに参加しているデータベースの詳細情報を取得するPowerShellコマンドレットです。データベースの同期状態、フェイルオーバー準備状況、レプリカ固有のステータス情報を含む包括的な情報を返します。

**業務上の目的・背景**：可用性グループ（AG）環境において、データベースの同期状態やフェイルオーバー準備状況を監視することは、高可用性を維持するために不可欠です。本コマンドは、AG内のデータベースヘルス情報を一元的に取得することで、DBAが迅速に問題を特定し、対処できるようにします。手動でSSMSやT-SQLを使用する場合と比較して、複数インスタンスにまたがる情報収集を効率化します。

**機能の利用シーン**：
- 可用性グループデータベースのヘルス監視
- 同期問題のトラブルシューティング
- フェイルオーバー準備状況の検証
- データベース同期状態のコンプライアンスレポート生成
- AG環境の定期的な健全性チェック

**主要な処理内容**：
1. 指定されたSQL Serverインスタンスに接続
2. 可用性グループ情報を取得（Get-DbaAvailabilityGroupを内部呼び出し）
3. 各可用性グループのAvailabilityDatabasesコレクションを走査
4. データベースフィルタリング（-Databaseパラメータ指定時）
5. 各データベースオブジェクトにメタデータプロパティを追加
6. カスタムビューでフォーマットされた結果をパイプライン出力

**関連システム・外部連携**：
- SQL Server SMO (Server Management Objects) との連携
- SQL Server可用性グループインフラストラクチャ
- Windows Server Failover Clustering (WSFC)

**権限による制御**：VIEW SERVER STATE権限またはsysadmin固定サーバーロールのメンバーシップが必要です。可用性グループの情報を取得するにはVIEW ANY DEFINITION権限も推奨されます。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | PowerShellコンソール/ISE | 主画面 | コマンド実行とパイプライン処理 |
| - | SQL Server Management Studio (SSMS) | 参照画面 | AG Dashboard（同等機能の視覚的表示） |

## 機能種別

SELECT（データ取得）/ 監視・レポート出力

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | No | 対象SQL Serverインスタンス（SQL Server 2012以上） | インスタンス接続可能性検証 |
| SqlCredential | PSCredential | No | 代替認証資格情報 | 有効なPSCredentialオブジェクト |
| AvailabilityGroup | string[] | No | 取得対象の可用性グループ名 | なし（存在しない場合は結果なし） |
| Database | string[] | No | 取得対象のデータベース名 | なし（存在しない場合は結果なし） |
| InputObject | AvailabilityGroup[] | No | パイプライン入力用AGオブジェクト | Microsoft.SqlServer.Management.Smo.AvailabilityGroup型 |
| EnableException | switch | No | 例外を有効化（詳細エラー表示） | なし |

### 入力データソース

- PowerShellパラメータ入力
- パイプラインからのAvailabilityGroupオブジェクト（Get-DbaAvailabilityGroup出力）
- SQL Server SMO経由のメタデータ

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | SQL Serverインスタンスのコンピュータ名 |
| InstanceName | string | SQL Serverインスタンス名 |
| SqlInstance | string | 完全なSQL Serverインスタンス名 |
| AvailabilityGroup | string | 可用性グループ名 |
| LocalReplicaRole | string | ローカルレプリカのロール（Primary/Secondary） |
| Name | string | データベース名 |
| SynchronizationState | enum | 同期状態（NotSynchronizing/Synchronizing/Synchronized/Reverting/Initializing） |
| IsFailoverReady | bool | フェイルオーバー準備完了フラグ |
| IsJoined | bool | AGに参加済みフラグ |
| IsSuspended | bool | データ移動中断フラグ |

### 出力先

- PowerShellパイプライン（標準出力）
- オブジェクト型：Microsoft.SqlServer.Management.Smo.AvailabilityDatabase（拡張プロパティ付き）

## 処理フロー

### 処理シーケンス

```
1. パラメータ検証
   └─ SqlInstanceまたはInputObjectの少なくとも一方が必須
2. インスタンス接続（SqlInstance指定時）
   └─ Get-DbaAvailabilityGroupを呼び出してAGオブジェクト取得
3. データベース走査
   └─ InputObject.AvailabilityDatabasesをforeach処理
4. フィルタリング
   └─ -Databaseパラメータ指定時、名前マッチング
5. プロパティ追加
   └─ Add-Memberで追加プロパティ（ComputerName等）を付与
6. 出力
   └─ Select-DefaultViewでフォーマットしてパイプライン出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{SqlInstance or InputObject?}
    B -->|Neither| C[Stop-Function: エラー]
    B -->|SqlInstance| D[Get-DbaAvailabilityGroup呼び出し]
    B -->|InputObject| E[パイプライン入力使用]
    D --> F[InputObjectにAG追加]
    E --> F
    F --> G[AvailabilityDatabasesをforeach]
    G --> H{Databaseフィルタ指定?}
    H -->|Yes| I{名前マッチ?}
    I -->|No| G
    I -->|Yes| J[プロパティ追加]
    H -->|No| J
    J --> K[Select-DefaultViewで出力]
    K --> G
    G -->|完了| L[終了]
    C --> L
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-01 | パラメータ排他 | SqlInstanceとInputObjectの少なくとも一方が必須 | 常時 |
| BR-02 | バージョン制限 | SQL Server 2012以上が必要 | 接続時 |
| BR-03 | フィルタ動作 | Database指定時、一致しないDBはスキップ | -Database指定時 |

### 計算ロジック

特になし（データ取得機能のため）

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| AG情報取得 | sys.availability_groups | SELECT | SMO経由での可用性グループ情報取得 |
| データベース情報取得 | sys.availability_databases_cluster | SELECT | AGデータベース情報取得 |

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

本コマンドはSMOを使用するため、直接T-SQLを発行しません。SMOが内部的にシステムビューにアクセスします。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ConnectionError | インスタンス接続失敗 | 接続情報・ネットワーク確認 |
| - | ParameterValidation | SqlInstance/InputObject両方未指定 | パラメータ指定を確認 |

### リトライ仕様

リトライ機能なし（呼び出し元での制御が必要）

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

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

## パフォーマンス要件

- 単一インスタンス・単一AGの場合：1秒以内
- 複数AGの場合：AG数に比例

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

- Windows認証/SQL認証/AD認証対応
- SqlCredentialによる資格情報の安全な受け渡し
- VIEW SERVER STATE権限要求

## 備考

- SQL Server 2012以上が必須（可用性グループ機能の導入バージョン）
- パイプライン処理に対応し、Get-DbaAvailabilityGroupとの連携が可能

---

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

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

### 推奨読解順序

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

SMOのAvailabilityDatabaseオブジェクトが主要なデータ構造です。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Get-DbaAgDatabase.ps1 | `public/Get-DbaAgDatabase.ps1` | 出力プロパティ定義（148行目のdefaults配列） |

**読解のコツ**: PowerShellのAdd-Memberを使用して、SMOオブジェクトに追加プロパティを動的に付与している点に注目してください。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Get-DbaAgDatabase.ps1 | `public/Get-DbaAgDatabase.ps1` | processブロック（126-151行目）がメイン処理 |

**主要処理フロー**:
1. **127-130行目**: パラメータ検証（SqlInstanceまたはInputObjectの必須チェック）
2. **132-134行目**: SqlInstance指定時のGet-DbaAvailabilityGroup呼び出し
3. **136-150行目**: データベース走査とプロパティ追加処理

#### Step 3: 依存コマンドを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Get-DbaAvailabilityGroup.ps1 | `public/Get-DbaAvailabilityGroup.ps1` | AG情報取得の内部呼び出し |
| 3-2 | Connect-DbaInstance.ps1 | `public/Connect-DbaInstance.ps1` | インスタンス接続処理 |

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

```
Get-DbaAgDatabase
    │
    ├─ Test-Bound (パラメータ検証)
    │
    ├─ Get-DbaAvailabilityGroup (SqlInstance指定時)
    │      └─ Connect-DbaInstance
    │
    ├─ Add-Member (プロパティ追加)
    │
    └─ Select-DefaultView (出力フォーマット)
```

### データフロー図

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

SqlInstance ───▶ Get-DbaAvailabilityGroup ─┐
                                           │
InputObject ───────────────────────────────┼─▶ AvailabilityDatabases走査
                                           │
                                           └─▶ Add-Member (プロパティ追加)
                                                     │
Database (filter) ─────────────────────────▶ Where フィルタ
                                                     │
                                                     ▼
                                           Select-DefaultView ───▶ パイプライン出力
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Get-DbaAgDatabase.ps1 | `public/Get-DbaAgDatabase.ps1` | ソース | メインコマンド実装 |
| Get-DbaAvailabilityGroup.ps1 | `public/Get-DbaAvailabilityGroup.ps1` | ソース | AG情報取得依存コマンド |
| Get-DbaAgDatabase.Tests.ps1 | `tests/Get-DbaAgDatabase.Tests.ps1` | テスト | 単体・統合テスト |
| dbatools.psd1 | `dbatools.psd1` | 設定 | モジュールマニフェスト（コマンド登録） |
| dbatools.psm1 | `dbatools.psm1` | 設定 | モジュール定義（コマンドエクスポート） |
