# 機能設計書 21-Resume-DbaAgDbDataMovement

## 概要

本ドキュメントは、SQL Server可用性グループデータベースのデータ同期を再開するResume-DbaAgDbDataMovement機能の設計仕様を記述する。

### 本機能の処理概要

Resume-DbaAgDbDataMovementは、一時停止されている可用性グループデータベースのデータ移動（同期）を再開するPowerShellコマンドレットである。

**業務上の目的・背景**：可用性グループ環境において、メンテナンス作業や障害対応のためにデータ同期を一時停止することがある。その後、正常運用に復帰するためには、停止していたデータ移動を再開し、セカンダリレプリカをプライマリと同期させる必要がある。本機能は、この再開操作をPowerShellから簡単かつ確実に実行可能にする。

**機能の利用シーン**：
- メンテナンス作業完了後のデータ同期再開
- ストレージ問題解決後の同期復旧
- 手動フェイルオーバー準備時の同期状態確認と再開
- 障害復旧時のセカンダリレプリカ再同期

**主要な処理内容**：
1. SqlInstanceまたはInputObjectパラメータから対象を特定
2. Get-DbaAgDatabaseを使用して可用性グループデータベースオブジェクトを取得
3. 各データベースに対してResumeDataMovement()メソッドを実行
4. 処理結果としてAvailabilityDatabaseオブジェクトを返却

**関連システム・外部連携**：SQL Server Management Objects (SMO) のAvailabilityDatabaseクラスを使用してSQL Serverと連携する。

**権限による制御**：可用性グループに対するALTER権限またはCONTROL権限が必要。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 5 | AGフェイルオーバー | 補助機能 | 可用性グループデータベースのデータ同期再開 |

## 機能種別

データ操作（可用性グループデータベースの状態変更）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | No | 対象SQL Serverインスタンス（SQL Server 2012以上） | SQL Server 2012以上であること |
| SqlCredential | PSCredential | No | 代替認証情報 | 有効なPSCredential |
| AvailabilityGroup | string | No | 可用性グループ名 | SqlInstance使用時はDatabase/AvailabilityGroupいずれか必須 |
| Database | string[] | No | 対象データベース名（複数指定可） | SqlInstance使用時はDatabase/AvailabilityGroupいずれか必須 |
| InputObject | AvailabilityDatabase[] | No | パイプラインからの可用性グループデータベースオブジェクト | SqlInstanceまたはInputObjectいずれか必須 |
| EnableException | switch | No | 例外を有効化 | - |

### 入力データソース

- SqlInstanceパラメータ：SQL Serverインスタンス名の直接指定
- InputObjectパラメータ：Get-DbaAgDatabaseからのパイプライン入力

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | SQL Serverインスタンスのコンピュータ名 |
| InstanceName | string | SQL Serverインスタンス名 |
| SqlInstance | string | 完全なSQL Serverインスタンス名 |
| AvailabilityGroup | string | 可用性グループ名 |
| LocalReplicaRole | string | レプリカのロール（Primary/Secondary） |
| Name | string | データベース名 |
| SynchronizationState | string | 同期状態（NotSynchronizing, Synchronizing等） |
| IsFailoverReady | bool | フェイルオーバー可能かどうか |
| IsJoined | bool | 可用性グループに参加しているか |
| IsSuspended | bool | データ移動が停止中か（再開後はFalse） |

### 出力先

- PowerShellパイプライン（Microsoft.SqlServer.Management.Smo.AvailabilityDatabaseオブジェクト）

## 処理フロー

### 処理シーケンス

```
1. パラメータ検証
   └─ SqlInstanceまたはInputObjectのいずれかが指定されていることを確認
2. 追加パラメータ検証（SqlInstance指定時）
   └─ DatabaseまたはAvailabilityGroupが指定されていることを確認
3. 対象データベース取得
   └─ Get-DbaAgDatabaseを使用してAvailabilityDatabaseオブジェクトを取得
4. 各データベースに対する処理
   └─ ShouldProcess確認後、ResumeDataMovement()メソッドを実行
5. 結果出力
   └─ 処理完了したAvailabilityDatabaseオブジェクトを返却
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{SqlInstance or InputObject?}
    B -->|Neither| C[Stop-Function: パラメータエラー]
    B -->|OK| D{SqlInstance指定?}
    D -->|Yes| E{Database/AG指定?}
    E -->|No| F[Stop-Function: パラメータエラー]
    E -->|Yes| G[Get-DbaAgDatabase実行]
    D -->|No| H[InputObjectを使用]
    G --> I[foreach agdb in InputObject]
    H --> I
    I --> J{ShouldProcess?}
    J -->|No| K[スキップ]
    J -->|Yes| L[ResumeDataMovement実行]
    L --> M{成功?}
    M -->|Yes| N[オブジェクト出力]
    M -->|No| O[Stop-Function: エラー]
    K --> P{次のDB?}
    N --> P
    O --> P
    P -->|Yes| I
    P -->|No| Q[終了]
    C --> Q
    F --> Q
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-01 | パラメータ相互排他 | SqlInstanceまたはInputObjectのいずれかが必須 | 常時 |
| BR-02 | SqlInstance時の追加パラメータ | SqlInstance指定時はDatabaseまたはAvailabilityGroupが必須 | SqlInstance指定時 |
| BR-03 | 確認プロンプト | ConfirmImpactがHighのため、デフォルトで確認プロンプトを表示 | WhatIfまたはConfirmが指定されていない場合 |

### 計算ロジック

特になし（状態変更操作のため）

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| ResumeDataMovement | sys.dm_hadr_database_replica_states | 状態変更 | データ移動の再開 |

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

#### sys.dm_hadr_database_replica_states

SMOのResumeDataMovement()メソッドにより内部的にALTER DATABASE ... RESUME文が実行され、is_suspended列がFalseに変更される。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | パラメータエラー | SqlInstanceとInputObjectの両方が未指定 | Stop-Functionでエラーメッセージ出力 |
| - | パラメータエラー | SqlInstance指定時にDatabase/AGが未指定 | Stop-Functionでエラーメッセージ出力 |
| - | 接続エラー | SQL Serverへの接続失敗 | Stop-Functionで継続可能エラー |
| - | 操作エラー | ResumeDataMovement失敗 | Stop-Functionで継続可能エラー |

### リトライ仕様

リトライ機能は実装されていない。エラー発生時は次のデータベースの処理を継続する（-Continueフラグ使用）。

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

SMOのResumeDataMovement()メソッドは内部的にSQL Serverトランザクションを使用する。各データベースの操作は独立しており、1つのデータベースでエラーが発生しても他のデータベースの処理は継続される。

## パフォーマンス要件

特に定義なし。操作自体は軽量で、通常は数秒以内に完了する。

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

- Windows認証、SQL Server認証、Active Directory認証をサポート
- MFA認証にはConnect-DbaInstanceの事前使用が必要
- 可用性グループに対するALTER権限が必要
- ShouldProcess実装によりWhatIfおよびConfirmをサポート

## 備考

- SQL Server 2012以上が必要
- データ移動が停止中のデータベースでのみ効果がある
- セカンダリレプリカで実行する必要がある場合がある

---

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

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

### 推奨読解順序

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

SMOのAvailabilityDatabaseクラスが中心的なデータ構造である。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Resume-DbaAgDbDataMovement.ps1 | `public/Resume-DbaAgDbDataMovement.ps1` | パラメータ定義と型（96-103行目）を確認 |

**読解のコツ**: PowerShellの`[Microsoft.SqlServer.Management.Smo.AvailabilityDatabase[]]`型は、SMOライブラリの可用性グループデータベースオブジェクトを表す。

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

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

**主要処理フロー**:
1. **105-108行目**: パラメータ検証（SqlInstanceまたはInputObjectの存在確認）
2. **110-115行目**: SqlInstance指定時の追加パラメータ検証
3. **117-119行目**: Get-DbaAgDatabaseを使用したデータベースオブジェクト取得
4. **121-130行目**: 各データベースに対するResumeDataMovement()実行

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Get-DbaAgDatabase.ps1 | `public/Get-DbaAgDatabase.ps1` | 可用性グループデータベースの取得ロジック |

**主要処理フロー**:
- **118行目**: Get-DbaAgDatabaseを呼び出してInputObjectを構築

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

```
Resume-DbaAgDbDataMovement
    │
    ├─ Test-Bound (パラメータ検証)
    │
    ├─ Stop-Function (エラー処理)
    │
    ├─ Get-DbaAgDatabase (データベース取得)
    │      └─ Connect-DbaInstance (接続)
    │
    └─ AvailabilityDatabase.ResumeDataMovement() (SMOメソッド)
```

### データフロー図

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

SqlInstance ───────────┐
                       │
SqlCredential ─────────┼──▶ Get-DbaAgDatabase ──▶ AvailabilityDatabase[]
                       │            │
Database ──────────────┤            │
                       │            ▼
AvailabilityGroup ─────┘    ResumeDataMovement()
                                    │
                                    ▼
InputObject ──────────────────────────────────────▶ AvailabilityDatabase[]
  (パイプライン)                                        (更新済みオブジェクト)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Resume-DbaAgDbDataMovement.ps1 | `public/Resume-DbaAgDbDataMovement.ps1` | ソース | メイン機能実装 |
| Get-DbaAgDatabase.ps1 | `public/Get-DbaAgDatabase.ps1` | ソース | 可用性グループデータベース取得 |
| Suspend-DbaAgDbDataMovement.ps1 | `public/Suspend-DbaAgDbDataMovement.ps1` | ソース | 対になる一時停止機能 |
