# 機能設計書 663-Get-DbaDbSynonym

## 概要

本ドキュメントは、SQL Serverインスタンスからデータベースシノニムとそのターゲットオブジェクトマッピングを取得するGet-DbaDbSynonym機能の設計仕様を記述したものである。

### 本機能の処理概要

Get-DbaDbSynonymは、データベースシノニムオブジェクトとそのターゲットオブジェクトの詳細（ベースサーバー、データベース、スキーマ、オブジェクト名）を返す機能である。

**業務上の目的・背景**：シノニムは、同じデータベース内または異なるデータベース、さらにはリモートサーバー上のオブジェクトを指すデータベーススコープのエイリアスである。DBAがデータベースの依存関係をドキュメント化し、クロスデータベース参照を追跡し、SQL Server環境全体でシノニムの使用状況を分析するために必要となる。出力にはシノニム定義とその基になるターゲットの両方が含まれ、データベースマイグレーションやリファクタリング計画時の影響分析に役立つ。

**機能の利用シーン**：
- データベース依存関係のドキュメント化
- マイグレーション前の影響分析
- クロスデータベース/クロスサーバー参照の可視化
- シノニム構成の監査

**主要な処理内容**：
1. 指定されたSQL Serverインスタンスへの接続確立
2. 対象データベースの決定（フィルタリング含む）
3. 各データベースからシノニムコレクションの取得
4. シノニム名、スキーマによるフィルタリング
5. 除外条件の適用
6. 結果オブジェクトへのメタデータ付加とパイプライン出力

**関連システム・外部連携**：SQL Server Management Objects (SMO)を使用してSQL Serverと連携し、シノニムのメタデータを取得する。

**権限による制御**：対象データベースへの読み取りアクセス権限が必要。データベースがアクセス不可の場合は自動的にスキップする。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | PowerShellコンソール | 主画面 | コマンド実行とテキスト出力表示 |

## 機能種別

データ参照（SELECT） / メタデータ取得

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstance[] | No | 対象SQL Serverインスタンス | パイプライン入力可能 |
| SqlCredential | PSCredential | No | 代替認証情報 | Windows/SQL/AD認証対応 |
| Database | string[] | No | 検索対象データベース | ワイルドカード対応 |
| ExcludeDatabase | string[] | No | 除外するデータベース | ワイルドカード対応 |
| Schema | string[] | No | フィルタ対象スキーマ | ワイルドカード対応 |
| ExcludeSchema | string[] | No | 除外するスキーマ | ワイルドカード対応 |
| Synonym | string[] | No | 取得するシノニム名 | 配列対応 |
| ExcludeSynonym | string[] | No | 除外するシノニム名 | 配列対応 |
| InputObject | Database[] | No | データベースオブジェクト | パイプライン入力可能 |
| EnableException | switch | No | 例外を有効化 | - |

### 入力データソース

- SqlInstance: パイプラインまたはパラメータから取得
- InputObject: Get-DbaDatabase等からパイプライン入力
- Database/Schema/Synonym: フィルタリング条件として使用

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | SQL Serverのコンピュータ名 |
| InstanceName | string | インスタンス名 |
| SqlInstance | string | 完全修飾インスタンス名 |
| Database | string | データベース名 |
| Schema | string | シノニムのスキーマ名 |
| Name | string | シノニム名 |
| BaseServer | string | ターゲットオブジェクトのリンクサーバー名 |
| BaseDatabase | string | ターゲットオブジェクトのデータベース名 |
| BaseSchema | string | ターゲットオブジェクトのスキーマ名 |
| BaseObject | string | ターゲットオブジェクト名 |

### 出力先

パイプライン出力（Microsoft.SqlServer.Management.Smo.Synonym型オブジェクト）

## 処理フロー

### 処理シーケンス

```
1. 入力検証
   └─ SqlInstanceまたはInputObjectが必要
2. データベースオブジェクトの取得
   └─ SqlInstance指定時はGet-DbaDatabase呼び出し
3. 各データベースの処理ループ
   └─ IsAccessibleチェック
4. シノニムコレクションの取得
   └─ $db.Synonymsプロパティ
5. フィルタリング処理
   └─ Synonym/Schema/除外条件の適用
6. 結果オブジェクトの構築と出力
   └─ NoteProperty追加とデフォルトビュー設定
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{SqlInstanceまたはInputObject?}
    B -->|No| C[Stop-Function]
    B -->|Yes| D[Get-DbaDatabase呼び出し]
    D --> E[各DBループ開始]
    E --> F{IsAccessible?}
    F -->|No| G[Continue]
    F -->|Yes| H[シノニム取得]
    H --> I{Synonym指定?}
    I -->|Yes| J[名前フィルタ]
    I -->|No| K{ExcludeSynonym?}
    J --> K
    K -->|Yes| L[除外フィルタ]
    K -->|No| M{Schema指定?}
    L --> M
    M -->|Yes| N[スキーマフィルタ]
    M -->|No| O{ExcludeSchema?}
    N --> O
    O -->|Yes| P[スキーマ除外]
    O -->|No| Q[結果出力]
    P --> Q
    Q --> R{次のDB?}
    G --> R
    R -->|Yes| E
    R -->|No| S[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-663-1 | アクセス不可DB除外 | IsAccessibleがfalseのDBは自動スキップ | 常時 |
| BR-663-2 | シノニム名フィルタ | Synonym指定時、名前が一致するもののみ返す | Synonym指定時 |
| BR-663-3 | スキーマフィルタ | Schema指定時、スキーマが一致するもののみ返す | Schema指定時 |
| BR-663-4 | 除外フィルタ | ExcludeSynonym/ExcludeSchema指定時、該当を除外 | Exclude*指定時 |

### 計算ロジック

特になし

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| 取得 | sys.synonyms (SMO経由) | SELECT | シノニムメタデータ取得 |

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

#### sys.synonyms (SMO経由)

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| SELECT | Schema, Name, BaseServer, BaseDatabase, BaseSchema, BaseObject | 全件または指定条件 | Synonymsコレクション経由 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | Stop | SqlInstanceもInputObjectも未指定 | Stop-Functionで停止 |
| - | Skip | データベースアクセス不可 | 自動スキップ |

### リトライ仕様

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

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

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

## パフォーマンス要件

- Synonymsコレクションはデータベースごとに取得
- フィルタリングはメモリ内で実行

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

- SqlCredentialパラメータで認証情報を安全に受け渡し
- Windows認証、SQL認証、AD認証に対応
- MFAサポートはConnect-DbaInstance経由で利用可能

## 備考

- SupportsShouldProcess属性があるが、実際にはデータ変更を行わない読み取り専用操作
- SMOのSynonymオブジェクトをそのまま返すため、追加のプロパティもSelect-Object *で参照可能

---

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

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

### 推奨読解順序

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

SMOのSynonymオブジェクトの構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | SMO Synonym | (SMO Documentation) | BaseServer, BaseDatabase, BaseSchema, BaseObject |

**読解のコツ**: Synonymオブジェクトは参照先情報をBase*プロパティで保持している。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Get-DbaDbSynonym.ps1 | `public/Get-DbaDbSynonym.ps1` | メイン処理の流れを把握 |

**主要処理フロー**:
1. **131-135行目**: 入力検証とエラーハンドリング
2. **137-139行目**: SqlInstance指定時のデータベース取得
3. **141-144行目**: データベースループとアクセス可能性チェック
4. **148-164行目**: フィルタリング処理（Synonym, ExcludeSynonym, Schema, ExcludeSchema）
5. **166-172行目**: NoteProperty追加とデフォルトビュー出力

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Get-DbaDatabase | `public/Get-DbaDatabase.ps1` | データベース取得処理 |
| 3-2 | Select-DefaultView | `internal/functions/` | デフォルト表示プロパティ設定 |

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

```
Get-DbaDbSynonym
    │
    ├─ Get-DbaDatabase (DB取得)
    │      └─ Connect-DbaInstance
    │
    ├─ $db.Synonyms (シノニム取得)
    │
    ├─ Where-Object (フィルタリング)
    │      ├─ Name -in $Synonym
    │      ├─ Name -notin $ExcludeSynonym
    │      ├─ Schema -in $Schema
    │      └─ Schema -notin $ExcludeSchema
    │
    ├─ Add-Member (プロパティ追加)
    │
    └─ Select-DefaultView (出力フォーマット)
```

### データフロー図

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

SqlInstance ───────────┐
                       │
SqlCredential ─────────┼──▶ Get-DbaDatabase ───────▶ Database[]
                       │
Database ──────────────┤
                       │
ExcludeDatabase ───────┤
                       │
InputObject ───────────┘
                              │
                              ▼
                        $db.Synonyms ──────────────▶ Synonym[]
                              │
Synonym ───────────────┐     │
ExcludeSynonym ────────┼──▶ Where-Object ──────────▶ Filtered[]
Schema ────────────────┤
ExcludeSchema ─────────┘
                              │
                              ▼
                        Add-Member ─────────────────▶ 拡張Synonym
                              │
                              ▼
                        Select-DefaultView ────────▶ パイプライン出力
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Get-DbaDbSynonym.ps1 | `public/Get-DbaDbSynonym.ps1` | ソース | メイン機能実装 |
| Get-DbaDatabase.ps1 | `public/Get-DbaDatabase.ps1` | ソース | データベース取得 |
| New-DbaDbSynonym.ps1 | `public/New-DbaDbSynonym.ps1` | ソース | シノニム作成（関連機能） |
| Remove-DbaDbSynonym.ps1 | `public/Remove-DbaDbSynonym.ps1` | ソース | シノニム削除（関連機能） |
| Select-DefaultView.ps1 | `internal/functions/` | ソース | 出力フォーマット |
