# 機能設計書 276-Remove-DbaDbMirrorMonitor

## 概要

本ドキュメントは、サーバーインスタンス上のすべてのデータベースに対するミラーリング監視ジョブを停止・削除するdbatools PowerShellコマンド`Remove-DbaDbMirrorMonitor`の機能設計書です。

### 本機能の処理概要

`Remove-DbaDbMirrorMonitor`は、SQL Serverインスタンス上でデータベースミラーリング監視ジョブを停止し、監視設定を削除します。内部的にsp_dbmmonitordropmonitoringストアドプロシージャを実行し、Add-DbaDbMirrorMonitorで設定した監視機能を解除します。

**業務上の目的・背景**：データベースミラーリング監視は、ミラーリングセッションの状態を定期的に記録するためのSQL Agentジョブです。ミラーリング構成を廃止する場合や、監視設定をリセットする必要がある場合に、本コマンドで監視機能を削除します。

**機能の利用シーン**：
- ミラーリング構成の完全廃止時
- 監視設定のリセット・再構成前
- SQL Agentジョブのクリーンアップ
- サーバー移行時の設定削除

**主要な処理内容**：
1. SQL Serverインスタンスへの接続
2. sp_dbmmonitordropmonitoringストアドプロシージャの実行
3. 結果をPSCustomObjectで出力

**関連システム・外部連携**：msdbデータベースのsp_dbmmonitordropmonitoringストアドプロシージャを使用します。

**権限による制御**：sysadmin固定サーバーロールのメンバーシップ、またはmsdbデータベースのdb_owner固定データベースロールのメンバーシップが必要です。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| N/A | PowerShellコンソール | 主画面 | コマンド実行・結果表示 |

## 機能種別

削除操作（DROP/DELETE）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | Yes | 対象SQL Serverインスタンス | Mandatory, ValueFromPipeline |
| SqlCredential | PSCredential | No | 代替認証情報 | Windows/SQL認証対応 |
| EnableException | switch | No | 例外処理の有効化 | - |
| WhatIf | switch | No | 実行シミュレーション | SupportsShouldProcess |
| Confirm | switch | No | 確認プロンプト | ConfirmImpact='Low' |

### 入力データソース

- SQL Serverインスタンスへの接続情報

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | SQL Serverのコンピュータ名 |
| InstanceName | string | インスタンス名 |
| SqlInstance | string | 完全修飾インスタンス名 |
| MonitorStatus | string | 操作結果（"Removed"） |

### 出力先

パイプライン出力（PSCustomObject）

## 処理フロー

### 処理シーケンス

```
1. SqlInstanceパラメータのループ処理
   └─ 各インスタンスに対して処理を実行
2. Connect-DbaInstanceで接続
   └─ MinimumVersion=9（SQL Server 2005以上）
3. ShouldProcess確認
   └─ Removing mirror monitoring
4. sp_dbmmonitordropmonitoring実行
   └─ msdb.dbo.sp_dbmmonitordropmonitoring
5. PSCustomObject出力
   └─ MonitorStatus="Removed"
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[SqlInstanceループ]
    B --> C[Connect-DbaInstance]
    C --> D{接続成功?}
    D -->|No| E[Stop-Function]
    D -->|Yes| F{ShouldProcess確認}
    F -->|No| G[スキップ]
    F -->|Yes| H[sp_dbmmonitordropmonitoring<br/>実行]
    H --> I{成功?}
    I -->|Yes| J[PSCustomObject作成]
    I -->|No| K[Stop-Function]
    J --> L[オブジェクト出力]
    L --> M[次のインスタンス]
    G --> M
    E --> M
    K --> M
    M --> N{次のインスタンス<br/>あり?}
    N -->|Yes| B
    N -->|No| O[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-276-01 | 最小バージョン | SQL Server 2005（バージョン9）以上が必要 | 常時 |
| BR-276-02 | 低確認レベル | ConfirmImpact='Low'で確認プロンプト抑制 | デフォルト |
| BR-276-03 | 単一操作 | インスタンス全体の監視を一括削除 | 常時 |

### 計算ロジック

特になし。単純なストアドプロシージャ呼び出し。

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

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

| 操作 | 対象 | 操作種別 | 概要 |
|-----|-------------|---------|------|
| 監視削除 | msdb | EXEC | sp_dbmmonitordropmonitoring |

### ストアドプロシージャ呼び出し

#### sp_dbmmonitordropmonitoring

```sql
EXEC msdb.dbo.sp_dbmmonitordropmonitoring
```

このストアドプロシージャは:
- Database Mirroring Monitor Jobを削除
- dbm_monitor_dataテーブルのデータを削除
- 関連する監視設定をクリーンアップ

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ConnectionError | インスタンス接続失敗 | 接続情報確認 |
| - | VersionError | SQL Server 2005未満 | バージョン確認 |
| - | ExecutionError | sp_dbmmonitordropmonitoring失敗 | 権限確認 |

### リトライ仕様

リトライ処理なし。エラー発生時はStop-Functionで処理継続。

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

- sp_dbmmonitordropmonitoring内部でトランザクション管理

## パフォーマンス要件

- 単一のストアドプロシージャ呼び出しのため即座に完了

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

- sysadmin権限またはmsdb db_owner権限が必要
- PSCredentialによる安全な認証情報管理

## 備考

- Add-DbaDbMirrorMonitorで設定した監視を解除
- SQL Server 2005以降で利用可能

---

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

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

### 推奨読解順序

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

出力オブジェクトの構造を理解します。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Remove-DbaDbMirrorMonitor.ps1 | `public/Remove-DbaDbMirrorMonitor.ps1` | 76-81行目: PSCustomObject出力構造 |

**読解のコツ**: この関数は非常にシンプルで、sp_dbmmonitordropmonitoringを呼び出すだけです。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Remove-DbaDbMirrorMonitor.ps1 | `public/Remove-DbaDbMirrorMonitor.ps1` | 関数全体の構造（88行） |

**主要処理フロー**:
1. **59行目**: CmdletBinding - SupportsShouldProcess, ConfirmImpact='Low'
2. **60-65行目**: パラメータ定義（4個）
3. **66行目**: process ブロック開始
4. **67-72行目**: インスタンスループと接続
5. **69行目**: Connect-DbaInstance -MinimumVersion 9
6. **73行目**: ShouldProcess確認
7. **75行目**: sp_dbmmonitordropmonitoring実行
8. **76-81行目**: PSCustomObject出力

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

```
Remove-DbaDbMirrorMonitor
    │
    └─ foreach ($instance in $SqlInstance)
           │
           ├─ Connect-DbaInstance -MinimumVersion 9
           │
           ├─ ShouldProcess確認
           │
           ├─ $server.Query("EXEC msdb.dbo.sp_dbmmonitordropmonitoring")
           │
           └─ PSCustomObject出力
                  └─ MonitorStatus = "Removed"
```

### データフロー図

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

SqlInstance ───────▶ Connect-DbaInstance ──────▶ Server Object
                            │
                            ▼
                    ShouldProcess確認
                            │
                            ▼
                    sp_dbmmonitordropmonitoring
                            │
                            ▼
                    PSCustomObject
                    (MonitorStatus: "Removed") ──▶ 出力
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Remove-DbaDbMirrorMonitor.ps1 | `public/Remove-DbaDbMirrorMonitor.ps1` | ソース | メイン機能実装（88行） |
| Remove-DbaDbMirrorMonitor.Tests.ps1 | `tests/Remove-DbaDbMirrorMonitor.Tests.ps1` | テスト | 単体テスト |
| Add-DbaDbMirrorMonitor.ps1 | `public/Add-DbaDbMirrorMonitor.ps1` | ソース | 対となる監視設定関数 |
