# 機能設計書 665-Remove-DbaDbSynonym

## 概要

本ドキュメントは、SQL Serverデータベースからシノニムを削除するRemove-DbaDbSynonym機能の設計仕様を記述したものである。

### 本機能の処理概要

Remove-DbaDbSynonymは、DROP SYNONYMコマンドを実行してSQL Serverデータベースから1つ以上のシノニムを削除する機能である。

**業務上の目的・背景**：シノニムは、テーブル、ビュー、その他のオブジェクトに代替名を提供するデータベースオブジェクトで、複雑なオブジェクト名の簡素化や抽象化レイヤーの提供に使用される。データベースのリファクタリング、マイグレーション、または一般的なメンテナンス作業中に廃止されたシノニムをクリーンアップする際、複数のデータベースやインスタンスにわたって手動でDROPステートメントをスクリプト化する必要がなくなる。

**機能の利用シーン**：
- データベースリファクタリング時の不要シノニムの削除
- マイグレーション後のクリーンアップ
- 複数データベース/インスタンスからの一括削除
- Get-DbaDbSynonymと連携した選択的削除

**主要な処理内容**：
1. 入力タイプの判定（インスタンス/サーバー/データベース/シノニム）
2. 対象シノニムの取得
3. ShouldProcessによる確認
4. DROP SYNONYM文の実行
5. 結果オブジェクトのパイプライン出力

**関連システム・外部連携**：SQL Server Management Objects (SMO)を使用してSQL Serverと連携し、T-SQLのDROP SYNONYM文を実行する。

**権限による制御**：対象データベースでのALTER権限が必要。対象スキーマに対するCONTROL権限も必要。

## 関連画面

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

## 機能種別

データ削除（DELETE/DROP） / DDL操作

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| 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 | object[] | No | 入力オブジェクト | サーバー/DB/シノニム |
| EnableException | switch | No | 例外を有効化 | - |

### 入力データソース

- SqlInstance: パイプラインまたはパラメータから取得
- InputObject: 複数タイプ対応（DbaInstanceParameter, Server, Database, Synonym）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | SQL Serverのコンピュータ名 |
| InstanceName | string | インスタンス名 |
| SqlInstance | string | 完全修飾インスタンス名 |
| Database | string | データベース名 |
| Synonym | string | 削除されたシノニム名 |
| Status | string | 操作結果（"Removed"） |

### 出力先

パイプライン出力（PSCustomObject）

## 処理フロー

### 処理シーケンス

```
1. 入力検証
   └─ SqlInstanceまたはInputObjectが必要
2. InputObjectのタイプ判定
   └─ DbaInstanceParameter/Server/Database/Synonym
3. シノニムの取得
   └─ タイプに応じてGet-DbaDbSynonym呼び出し
4. 各シノニムに対する削除処理
   └─ ShouldProcess確認後、DROP SYNONYM実行
5. 結果オブジェクトの出力
   └─ PSCustomObjectでStatus付与
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{SqlInstanceまたはInputObject?}
    B -->|No| C[Stop-Function]
    B -->|Yes| D{SqlInstance指定?}
    D -->|Yes| E[InputObject = SqlInstance]
    D -->|No| F[InputObject使用]
    E --> G[各inputループ]
    F --> G
    G --> H{inputType判定}
    H -->|DbaInstanceParameter| I[Get-DbaDbSynonym]
    H -->|Server| J[Get-DbaDbSynonym]
    H -->|Database| K[Get-DbaDbSynonym]
    H -->|Synonym| L[直接使用]
    H -->|Other| M[Stop-Function]
    I --> N[各シノニムループ]
    J --> N
    K --> N
    L --> N
    N --> O{ShouldProcess?}
    O -->|No| P{次のシノニム?}
    O -->|Yes| Q[DROP SYNONYM実行]
    Q --> R{成功?}
    R -->|Yes| S[結果オブジェクト出力]
    R -->|No| T[Stop-Function -Continue]
    S --> P
    T --> P
    P -->|Yes| N
    P -->|No| U{次のinput?}
    M --> U
    U -->|Yes| G
    U -->|No| V[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-665-1 | 入力必須 | SqlInstanceまたはInputObjectが必要 | 常時 |
| BR-665-2 | 複数タイプ対応 | DbaInstanceParameter/Server/Database/Synonymを受入 | InputObject使用時 |
| BR-665-3 | 確認付き削除 | ConfirmImpact=Highにより確認プロンプト表示 | 常時 |
| BR-665-4 | T-SQL実行 | SMO Drop()ではなく$db.Query()でDROP SYNONYM実行 | 常時 |

### 計算ロジック

特になし

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| 削除 | sys.synonyms | DELETE | シノニム削除 |

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

#### sys.synonyms (T-SQL経由)

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| DELETE | - | DROP SYNONYM $dbSynonym | Query()メソッド経由 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | Stop | SqlInstanceもInputObjectも未指定 | Stop-Functionで停止 |
| - | Stop | InputObjectが無効なタイプ | Stop-Functionで停止 |
| - | Stop-Continue | DROP SYNONYM実行失敗 | エラー出力後、次シノニムへ継続 |

### リトライ仕様

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

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

DROP SYNONYMは暗黙のトランザクションで即座にコミットされる。

## パフォーマンス要件

- シノニム削除は軽量なDDL操作
- 複数シノニムを順次削除するため、対象数に比例した処理時間

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

- SqlCredentialパラメータで認証情報を安全に受け渡し
- ConfirmImpact=Highにより誤削除防止
- SupportsShouldProcessでWhatIf/Confirm対応

## 備考

- Get-DbaDbSynonymと連携してパイプラインで選択的削除が可能
- DROP SYNONYMは$dbSynonymを直接クエリに埋め込むため、シノニム名がそのまま使用される
- 列挙の問題を回避するためにSMOのDrop()ではなくQuery()を使用

---

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

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

### 推奨読解順序

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

入力可能なオブジェクトタイプと出力PSCustomObjectの構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Remove-DbaDbSynonym.ps1 | `public/Remove-DbaDbSynonym.ps1` | InputObjectの型判定ロジック |

**読解のコツ**: GetType().FullNameで入力オブジェクトのタイプを判定し、それに応じた処理分岐を行う。

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

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

**主要処理フロー**:
1. **121-125行目**: 入力検証
2. **127-129行目**: SqlInstance指定時のInputObject設定
3. **131-154行目**: InputObjectタイプによる分岐処理
4. **156-179行目**: 各シノニムに対する削除処理とShouldProcess

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Get-DbaDbSynonym | `public/Get-DbaDbSynonym.ps1` | シノニム取得処理 |

**主要処理フロー**:
- タイプに応じてGet-DbaDbSynonymにフィルタパラメータを渡してシノニム取得

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

```
Remove-DbaDbSynonym
    │
    ├─ GetType().FullName (タイプ判定)
    │
    ├─ Get-DbaDbSynonym (シノニム取得)
    │      ├─ DbaInstanceParameter → フルパラメータ
    │      ├─ Server → フルパラメータ
    │      └─ Database → InputObject
    │
    ├─ ShouldProcess (確認)
    │
    └─ $db.Query("DROP SYNONYM $dbSynonym")
           │
           └─ PSCustomObject出力
```

### データフロー図

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

SqlInstance ───────────┐
                       │
InputObject ───────────┼──▶ タイプ判定
                       │      │
                       │      ├─▶ DbaInstanceParameter
                       │      │     └─▶ Get-DbaDbSynonym ─▶ Synonym[]
                       │      │
                       │      ├─▶ Server
                       │      │     └─▶ Get-DbaDbSynonym ─▶ Synonym[]
                       │      │
                       │      ├─▶ Database
                       │      │     └─▶ Get-DbaDbSynonym ─▶ Synonym[]
                       │      │
                       │      └─▶ Synonym
Database ──────────────┤            └─▶ 直接使用 ─────────▶ Synonym[]
ExcludeDatabase ───────┤
Schema ────────────────┤
ExcludeSchema ─────────┤
Synonym ───────────────┤
ExcludeSynonym ────────┘
                              │
                              ▼
                        ShouldProcess確認
                              │
                              ▼
                        DROP SYNONYM実行
                              │
                              ▼
                        PSCustomObject ──────────────▶ パイプライン出力
                        (Status="Removed")
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Remove-DbaDbSynonym.ps1 | `public/Remove-DbaDbSynonym.ps1` | ソース | メイン機能実装 |
| Get-DbaDbSynonym.ps1 | `public/Get-DbaDbSynonym.ps1` | ソース | シノニム取得 |
| New-DbaDbSynonym.ps1 | `public/New-DbaDbSynonym.ps1` | ソース | シノニム作成（関連機能） |
