# 機能設計書 433-Get-DbaRegServerStore

## 概要

本ドキュメントは、dbatools PowerShellモジュールにおけるGet-DbaRegServerStore機能の設計仕様を定義する。

### 本機能の処理概要

Get-DbaRegServerStoreは、SQL Server Central Management Server（CMS）の構成を管理するためのRegisteredServersStoreオブジェクトを作成・取得する機能である。

**業務上の目的・背景**：Central Management Server（CMS）は複数のSQL Serverインスタンスを一元管理するための重要なインフラストラクチャである。この機能は、CMSストアオブジェクトを取得することで、サーバーグループや登録サーバーへのプログラマティックなアクセスを提供する。他のdbatools CMS関連コマンドの基盤として機能し、CMS操作の自動化を可能にする。

**機能の利用シーン**：
- CMSのサーバーグループ構造を確認する場合
- 登録サーバー情報にプログラム的にアクセスする場合
- CMSの接続状態を確認する場合
- ローカル登録サーバーファイルストアにアクセスする場合
- 他のCMS操作コマンドの内部で使用される場合

**主要な処理内容**：
1. SqlInstance指定時はConnect-DbaInstanceでCMSに接続
2. RegisteredServersStoreオブジェクトを作成
3. ComputerName、InstanceName、SqlInstanceプロパティを追加
4. SqlInstance未指定時はローカルファイルストアを初期化して返却

**関連システム・外部連携**：SQL Server Central Management Server（CMS）、ローカルSSMS登録サーバーファイル

**権限による制御**：CMSへの接続権限（Windows認証またはSQL認証）が必要。ローカルファイルストアはユーザープロファイルへのアクセス権で制御。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | 該当なし（コマンドライン機能） | - | - |

## 機能種別

データ取得 / オブジェクト生成

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | No | CMSをホストするSQL Serverインスタンス | パイプライン入力可能 |
| SqlCredential | PSCredential | No | 代替認証情報 | - |
| EnableException | switch | No | 例外処理の有効化 | - |

### 入力データソース

- SQL Server Central Management Server（CMS）インスタンス
- ローカルSSMS登録サーバーファイル（SqlInstance未指定時）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | CMSをホストするコンピュータ名 |
| InstanceName | string | SQL Serverインスタンス名 |
| SqlInstance | string | 完全なSQL Serverインスタンス名（computer\instance形式） |
| DatabaseEngineServerGroup | ServerGroup | 全登録サーバーとサブグループを含むルートグループ |
| ServerGroups | Collection | トップレベルサーバーグループのコレクション |
| RegisteredServers | Collection | ルートレベルの登録サーバーコレクション |
| ParentServer | SMO Server | 親サーバーオブジェクト（内部使用） |

### 出力先

- パイプライン出力（RegisteredServersStoreオブジェクト）
- Select-DefaultViewで一部プロパティを除外して表示

## 処理フロー

### 処理シーケンス

```
1. SqlInstance指定時の処理
   └─ Connect-DbaInstanceでCMSに接続
2. RegisteredServersStoreオブジェクト作成
   └─ ServerConnectionContextを使用してインスタンス化
3. カスタムプロパティの追加
   └─ ComputerName、InstanceName、SqlInstance、ParentServerを追加
4. 出力の整形
   └─ Select-DefaultViewで内部プロパティを除外
5. SqlInstance未指定時の処理
   └─ LocalFileStoreを初期化
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{SqlInstance指定?}
    B -->|Yes| C[foreach SqlInstance]
    C --> D[Connect-DbaInstance]
    D --> E{接続成功?}
    E -->|No| F[Stop-Function エラー]
    E -->|Yes| G[RegisteredServersStore作成]
    G --> H{作成成功?}
    H -->|No| I[Stop-Function エラー]
    H -->|Yes| J[Add-Memberでプロパティ追加]
    J --> K[Select-DefaultView出力]
    K --> L{次のインスタンス?}
    L -->|Yes| C
    L -->|No| M[終了]
    B -->|No| N[LocalFileStore取得]
    N --> O{ファイル存在?}
    O -->|No| P[RegSrvr.xmlをコピー]
    P --> Q[InitChildObjects呼び出し]
    O -->|Yes| Q
    Q --> M
    F --> L
    I --> L
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | ローカルファイル初期化 | ローカルファイルストアが存在しない場合、モジュールのRegSrvr.xmlをコピー | SqlInstance未指定かつファイル不存在時 |
| BR-002 | 内部プロパティ除外 | ServerConnection等の内部プロパティはデフォルト表示から除外 | 常時 |
| BR-003 | ParentServer保持 | 後続処理のためにParentServerプロパティを保持 | 常時 |

### 計算ロジック

特になし。

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| N/A | N/A | N/A | データベースへの直接操作なし |

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

本機能はデータベーステーブルへの直接操作を行わない。SMOを介してCMSメタデータにアクセス。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ConnectionError | SQL Server接続失敗 | 接続情報、ネットワーク、権限を確認 |
| - | ConnectionError | CMSストア作成失敗 | CMSが正しく構成されているか確認 |

### リトライ仕様

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

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

トランザクション管理は不要（読み取り専用操作）。

## パフォーマンス要件

特定のパフォーマンス要件は定義されていない。

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

- CMSへのアクセスにはWindows認証、SQL認証、Active Directory認証をサポート
- MFAサポートにはConnect-DbaInstanceを事前に使用

## 備考

- 他のCMS関連コマンド（Get-DbaRegServer、Get-DbaRegServerGroup等）の内部で使用される基盤機能
- ローカルファイルストアの初期化にはリフレクションを使用（InitChildObjectsは非公開メソッド）

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Microsoft.SqlServer.Management.RegisteredServers.RegisteredServersStore | (SMO) | ストアオブジェクトの構造理解 |

**読解のコツ**: RegisteredServersStoreはCMSの最上位オブジェクトで、DatabaseEngineServerGroupからサーバーグループ階層にアクセスできる。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Get-DbaRegServerStore.ps1 | `public/Get-DbaRegServerStore.ps1` | パラメータ定義、process block構造 |

**主要処理フロー**:
1. **66-72行目**: パラメータ定義
2. **73-78行目**: Connect-DbaInstanceでCMS接続
3. **80-85行目**: RegisteredServersStoreオブジェクト作成

#### Step 3: プロパティ追加と出力を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Get-DbaRegServerStore.ps1 | `public/Get-DbaRegServerStore.ps1` | Add-Memberによるプロパティ追加 |

**主要処理フロー**:
- **87-90行目**: ComputerName、InstanceName、SqlInstance、ParentServerを追加
- **91行目**: Select-DefaultViewで内部プロパティを除外

#### Step 4: ローカルファイルストア処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | Get-DbaRegServerStore.ps1 | `public/Get-DbaRegServerStore.ps1` | SqlInstance未指定時の処理 |

**主要処理フロー**:
- **94-106行目**: LocalFileStoreの初期化処理
- **96行目**: LocalFileStore.DomainInstanceNameでファイルパス取得
- **98-100行目**: ファイル不存在時はRegSrvr.xmlをコピー
- **102-104行目**: リフレクションでInitChildObjectsを呼び出し

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

```
Get-DbaRegServerStore
    │
    ├─ Connect-DbaInstance
    │      └─ SQL Server接続
    │
    ├─ New-Object RegisteredServersStore
    │      └─ ストアオブジェクト作成
    │
    ├─ Add-Member
    │      └─ カスタムプロパティ追加
    │
    └─ Select-DefaultView
           └─ 出力整形
```

### データフロー図

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

SqlInstance ───────▶ Connect-DbaInstance ──────┐
                            │                   │
                            ▼                   │
                     New-Object                 │
                     RegisteredServersStore     │
                            │                   │
                            ▼                   │
                     Add-Member ────────────────┼──▶ RegisteredServersStore
                     (プロパティ追加)            │
                                               │
ローカルファイル ──▶ InitChildObjects ──────────┘
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Get-DbaRegServerStore.ps1 | `public/Get-DbaRegServerStore.ps1` | ソース | メイン機能実装 |
| Connect-DbaInstance.ps1 | `public/Connect-DbaInstance.ps1` | ソース | SQL Server接続 |
| RegSrvr.xml | `bin/RegSrvr.xml` | 設定 | 初期ローカルファイルテンプレート |
