# 機能設計書 110-Get-DbaDbServiceBrokerService

## 概要

本ドキュメントは、SQL ServerデータベースのService Brokerサービスを取得するGet-DbaDbServiceBrokerService機能の設計仕様を定義する。

### 本機能の処理概要

本機能は、SQL Serverデータベースに構成されているService Brokerサービスの詳細情報を取得する。サービス名、関連するキュー、スキーマ、所有権の詳細などを含む。Service Brokerサービスは、アプリケーション間やデータベース間の信頼性の高いメッセージングのエンドポイントを定義する。

**業務上の目的・背景**：Service Brokerサービスは、メッセージベースのアプリケーションにおいてメッセージングのエンドポイントを定義する重要なコンポーネントである。DBAはこれらのサービスを監査し、メッセージベースアプリケーションのトラブルシューティングを行い、移行計画やコンプライアンスのためにメッセージング構成を文書化する必要がある。

**機能の利用シーン**：
- Service Broker実装の監査
- メッセージベースアプリケーションのトラブルシューティング
- 移行計画のための構成文書化
- サービス設定のコンプライアンス確認
- サービスとキューの関連付け確認

**主要な処理内容**：
1. Get-DbaDatabaseを使用したデータベースオブジェクト取得
2. 各データベースのServiceBroker.Servicesコレクションにアクセス
3. システムサービス除外オプションの適用
4. カスタムプロパティの追加とデフォルト出力形式の制御

**関連システム・外部連携**：SMOを使用してSQL ServerのService Brokerオブジェクトにアクセス。

**権限による制御**：対象データベースへのVIEW DEFINITION権限が必要。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 51 | Service Broker | 補助機能 | Service Brokerサービスの取得 |

## 機能種別

データ取得処理（メタデータ取得）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | No | 対象のSQL Serverインスタンス | パイプライン入力対応 |
| SqlCredential | PSCredential | No | 代替認証情報 | Windows/SQL認証、AD統合認証 |
| Database | object[] | No | 対象データベース名 | 存在するデータベース名 |
| ExcludeDatabase | object[] | No | 除外するデータベース名 | 存在するデータベース名 |
| ExcludeSystemService | switch | No | システムサービスを除外 | - |
| EnableException | switch | No | 例外処理モードの切り替え | - |

### 入力データソース

- SqlInstance: コマンドラインパラメータ

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | SQL Serverをホストするコンピュータ名 |
| InstanceName | string | SQL Serverインスタンス名 |
| SqlInstance | string | 完全なSQL Serverインスタンス名 |
| Database | string | サービスを含むデータベース名 |
| Owner | string | サービスの所有者 |
| ServiceID | int | サービスの一意オブジェクトID |
| Name | string | Service Brokerサービス名 |
| QueueSchema | string | 関連するキューのスキーマ名 |
| QueueName | string | 関連するキュー名 |

### 出力先

PowerShellパイプライン（Microsoft.SqlServer.Management.Smo.ServiceBrokerService）

## 処理フロー

### 処理シーケンス

```
1. SqlInstance指定の確認
   └─ 指定時: Get-DbaDatabaseを呼び出し
2. データベースごとの処理ループ
   └─ アクセシビリティチェック
3. ServiceBroker.Servicesコレクションの確認
   └─ サービスなしの場合: メッセージ出力
4. サービスごとの処理ループ
   └─ システムサービス除外の判定
   └─ カスタムプロパティの追加（Add-Member）
5. Select-DefaultViewで出力形式を制御
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{SqlInstance指定?}
    B -->|Yes| C[Get-DbaDatabase呼び出し]
    C --> D[InputObjectに格納]
    B -->|No| D
    D --> E{データベースループ}
    E -->|次のDB| F{IsAccessible?}
    F -->|No| G[警告出力]
    G --> E
    F -->|Yes| H{Services.Count > 0?}
    H -->|No| I[メッセージ出力]
    I --> E
    H -->|Yes| J{サービスループ}
    J -->|次のサービス| K{ExcludeSystemService & IsSystemObject?}
    K -->|除外| J
    K -->|対象| L[Add-Memberでプロパティ追加]
    L --> M[Select-DefaultView]
    M --> J
    J -->|完了| E
    E -->|完了| N[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-1001 | アクセシビリティチェック | アクセス不可能なデータベースは警告出力してスキップ | データベースループ時 |
| BR-1002 | システムサービス除外 | ExcludeSystemServiceスイッチ指定時はIsSystemObjectがtrueのサービスをスキップ | サービスループ時 |
| BR-1003 | 空サービスコレクション | サービスが存在しない場合はOutputレベルでメッセージ出力 | サービスチェック時 |

### 計算ロジック

特に計算ロジックはなく、SMOオブジェクトのプロパティを直接取得。

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

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

| 操作 | 対象テーブル/ビュー | 操作種別 | 概要 |
|-----|-------------|---------|------|
| サービス情報取得 | SMO ServiceBroker.Services | メタデータ読取 | Service Brokerサービスコレクション |

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

SMOを使用してメタデータを取得。内部的にはsys.services等のカタログビューにアクセス。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | 警告 | データベースがアクセス不可 | スキップして次のDBを処理 |
| - | Output | Service Brokerサービスが存在しない | メッセージ出力して次のDBを処理 |

### リトライ仕様

リトライは実装されていない。

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

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

## パフォーマンス要件

SMOメタデータアクセスのため、高速に動作。

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

- VIEW DEFINITION権限が必要
- SqlCredentialパラメータで代替認証情報をサポート

## 備考

- 関連コマンド：Get-DbaDbServiceBrokerQueue（Service Brokerキューの取得）
- サービスとキューは1対1で関連付けられている

---

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

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

### 推奨読解順序

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

出力オブジェクトの構造と追加プロパティを理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Get-DbaDbServiceBrokerService.ps1 | `public/Get-DbaDbServiceBrokerService.ps1` | 124-130行目：Add-Memberとデフォルトプロパティ |

**読解のコツ**: SMOのServiceBrokerServiceオブジェクトに`Add-Member`で動的にComputerName等を追加。`Select-DefaultView`でデフォルト表示プロパティを制御。'ID as ServiceID'でエイリアス指定。

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

パラメータ定義とデータベース取得ロジックを確認。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Get-DbaDbServiceBrokerService.ps1 | `public/Get-DbaDbServiceBrokerService.ps1` | 93-102行目：パラメータ定義 |

**主要処理フロー**:
1. **105-107行目**: SqlInstance指定時のGet-DbaDatabase呼び出し
2. **109-113行目**: アクセシビリティチェック
3. **114-117行目**: サービスコレクション存在チェック
4. **119-131行目**: サービスループとプロパティ追加

#### Step 3: フィルタリングとプロパティ追加を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Get-DbaDbServiceBrokerService.ps1 | `public/Get-DbaDbServiceBrokerService.ps1` | 120-122行目：システムサービス除外 |
| 3-2 | Get-DbaDbServiceBrokerService.ps1 | `public/Get-DbaDbServiceBrokerService.ps1` | 124-127行目：Add-Member |

**主要処理フロー**:
- **120-122行目**: Test-Boundで ExcludeSystemService の存在確認 & IsSystemObject判定
- **124-127行目**: `$service.Parent.Parent`からComputerName等を取得（Parent階層: Service→ServiceBroker→Database）

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

```
Get-DbaDbServiceBrokerService
    │
    ├─ Test-Bound（パラメータ存在確認）
    │
    ├─ Get-DbaDatabase（SqlInstance指定時）
    │
    ├─ Write-Message（ログ/警告/情報出力）
    │
    ├─ Add-Member（プロパティ追加）
    │
    └─ Select-DefaultView（出力形式制御）
```

### データフロー図

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

SqlInstance ───▶ Get-DbaDatabase
                      │
Database ─────────────┤
                      ▼
               ┌─────────────────┐
               │ DBループ        │
               │ (IsAccessible)  │
               └────────┬────────┘
                        │
                        ▼
               ┌─────────────────┐
               │ ServiceBroker.  │
               │ Services        │
               └────────┬────────┘
                        │
                        ▼
               ┌─────────────────┐
               │ サービスループ  │
               │ (システム除外)  │
               └────────┬────────┘
                        │
                        ▼
               ┌─────────────────┐      ┌─ ComputerName
               │ ServiceBroker   │──────┼─ Database
               │ Service         │      ├─ Owner
               └─────────────────┘      ├─ ServiceID
                                        ├─ Name
                                        ├─ QueueSchema
                                        └─ QueueName
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Get-DbaDbServiceBrokerService.ps1 | `public/Get-DbaDbServiceBrokerService.ps1` | ソース | メイン処理 |
| Get-DbaDatabase.ps1 | `public/Get-DbaDatabase.ps1` | ソース | データベースオブジェクト取得 |
| Select-DefaultView.ps1 | `internal/functions/Select-DefaultView.ps1` | ソース | 出力形式制御 |
