# 機能設計書 535-Remove-DbaDbSchema

## 概要

本ドキュメントは、dbatools PowerShellモジュールにおけるRemove-DbaDbSchema機能の設計仕様を定義するものである。この機能はSQL Serverデータベースからスキーマを削除する。

### 本機能の処理概要

**業務上の目的・背景**：データベース保守、開発環境のリセット、アプリケーション廃止時に、不要になったスキーマを削除する必要がある。本機能は、T-SQLのDROP SCHEMA文を使用してスキーマを削除する。スキーマ削除前には、スキーマ内のすべてのオブジェクト（テーブル、ビュー、関数等）を別スキーマに移動または削除する必要がある。

**機能の利用シーン**：
- アプリケーション廃止に伴うスキーマクリーンアップ
- 開発・テスト環境のリセット
- スキーマ統合・再編成
- マルチテナント環境でのテナント削除
- CI/CDパイプラインでの環境クリーンアップ

**主要な処理内容**：
1. SqlInstance指定時のDatabaseパラメータ必須チェック
2. Get-DbaDatabase経由でのデータベースオブジェクト取得
3. Get-DbaDbSchema経由でのスキーマオブジェクト取得
4. Drop()メソッドによるスキーマ削除

**関連システム・外部連携**：
- SQL Server Management Objects (SMO) - Schema.Drop() メソッド
- Get-DbaDatabase - データベースオブジェクト取得
- Get-DbaDbSchema - スキーマオブジェクト取得

**権限による制御**：
- 対象スキーマに対するCONTROL権限またはALTER ANY SCHEMA権限
- スキーマが空であること（オブジェクトを含まないこと）

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 39 | スキーマ管理 | 主機能 | データベーススキーマの削除 |

## 機能種別

データ削除処理（DELETE / DROP）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | No | 対象SQL Serverインスタンス | 有効なSQL Server接続文字列 |
| SqlCredential | PSCredential | No | SQL Server接続用の代替認証情報 | 有効なPSCredentialオブジェクト |
| Database | string[] | No* | 対象データベース名（SqlInstance指定時は必須） | - |
| Schema | string[] | Yes | 削除するスキーマ名 | スキーマが空であること |
| InputObject | Microsoft.SqlServer.Management.Smo.Database[] | No | パイプライン入力のデータベースオブジェクト | - |
| EnableException | switch | No | 例外を呼び出し元にスローする | - |

### 入力データソース

- パラメータ入力（コマンドライン引数）
- パイプライン入力（Get-DbaDatabase出力）

## 出力仕様

### 出力データ

なし（削除操作のため出力オブジェクトなし）

### 出力先

なし

## 処理フロー

### 処理シーケンス

```
1. パラメータ検証（processブロック）
   └─ SqlInstance指定時のDatabase必須チェック

2. データベースオブジェクト取得
   └─ Get-DbaDatabase呼び出しでInputObject構築

3. データベースループ処理
   └─ スキーマループ処理
       ├─ ShouldProcess確認
       ├─ Get-DbaDbSchemaでスキーマオブジェクト取得
       └─ Drop()メソッド実行
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{SqlInstance指定?}
    B -->|Yes| C{Database指定?}
    C -->|No| D[エラー: Database必須]
    C -->|Yes| E[Get-DbaDatabase]
    B -->|No| F[InputObject使用]
    E --> G[InputObjectに追加]
    F --> G
    G --> H[foreach db in InputObject]
    H --> I[foreach sName in Schema]
    I --> J{ShouldProcess?}
    J -->|No| K[スキップ]
    J -->|Yes| L[Get-DbaDbSchema]
    L --> M[Drop実行]
    M --> N{成功?}
    N -->|No| O[エラー出力]
    N -->|Yes| P{次のスキーマ?}
    O --> P
    K --> P
    P -->|Yes| I
    P -->|No| Q{次のDB?}
    Q -->|Yes| H
    Q -->|No| R[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | DB必須条件 | SqlInstance指定時はDatabase必須 | SqlInstance指定時 |
| BR-002 | スキーマ空要件 | 削除対象スキーマはオブジェクトを含まないこと | 常時 |
| BR-003 | 確認プロンプト | ConfirmImpact=Highのため確認が表示される | -Confirm未指定時 |

### 計算ロジック

特になし

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| スキーマ削除 | sys.schemas | DELETE | スキーマレコード削除 |

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

#### sys.schemas

SMO Schema.Drop()メソッド経由で以下相当のDDLが実行される：
```sql
DROP SCHEMA [スキーマ名]
```

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | パラメータ不足 | SqlInstance指定時にDatabase未指定 | Databaseパラメータを指定 |
| - | 削除失敗 | スキーマにオブジェクトが存在 | オブジェクトを移動または削除 |
| - | 権限不足 | DROP権限なし | 必要な権限を付与 |

### リトライ仕様

Stop-Function -Continueにより、エラー発生時も次のスキーマ/データベース処理を継続する。

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

SMO Schema.Drop()メソッドが内部的にトランザクションを管理する。

## パフォーマンス要件

- スキーマ削除は通常即座に完了
- スキーマにオブジェクトが存在する場合はエラーとなるため高速にフェイル

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

- CONTROL権限またはALTER ANY SCHEMA権限が必要
- ConfirmImpact=Highにより、デフォルトで確認プロンプトが表示される
- 削除は取り消し不可のため、慎重に実行すること

## 備考

- スキーマ内にオブジェクトが存在する場合は削除不可
- 事前にオブジェクトを別スキーマに移動（ALTER SCHEMA ... TRANSFER）するか、削除が必要
- システムスキーマ（dbo, sys等）は削除不可

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Remove-DbaDbSchema.ps1 | `public/Remove-DbaDbSchema.ps1` | 出力なし（削除操作）- .OUTPUTSセクション確認 |

**読解のコツ**: 削除操作のため出力オブジェクトはない。処理結果はエラーメッセージまたは成功時の無言で示される。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Remove-DbaDbSchema.ps1 | `public/Remove-DbaDbSchema.ps1` | param()ブロック（69-79行目）でパラメータ定義確認 |

**主要処理フロー**:
1. **80行目**: processブロック開始
2. **82-85行目**: SqlInstance指定時のDatabase必須チェック
3. **87-89行目**: Get-DbaDatabase呼び出し
4. **91-104行目**: データベース/スキーマループと削除処理

#### Step 3: スキーマ削除ロジックを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Remove-DbaDbSchema.ps1 | `public/Remove-DbaDbSchema.ps1` | 93-102行目のスキーマ削除処理 |

**主要処理フロー**:
- **95行目**: ShouldProcess確認
- **97行目**: Get-DbaDbSchemaでスキーマオブジェクト取得
- **98行目**: Drop()メソッド実行
- **99-101行目**: エラーハンドリング

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

```
Remove-DbaDbSchema
    │
    ├─ Test-Bound（パラメータ検証）
    │      └─ Database必須チェック（SqlInstance指定時）
    │
    ├─ Get-DbaDatabase（データベースオブジェクト取得）
    │      └─ SqlInstance + Database フィルタ
    │
    └─ foreach db
           └─ foreach sName
                  ├─ ShouldProcess確認
                  ├─ Get-DbaDbSchema（スキーマオブジェクト取得）
                  └─ Drop()メソッド実行
```

### データフロー図

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

SqlInstance ─────────▶ Get-DbaDatabase ───────────▶ Database[]
      +                       │
Database ────────────────────┤
      or                      │
InputObject ─────────────────┤
                              ▼
Schema[] ────────────▶ Get-DbaDbSchema ───────────▶ Schema Object
                              │
                              ▼
                       ShouldProcess確認
                              │
                              ▼
                       Drop() ─────────────────────▶ (なし)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Remove-DbaDbSchema.ps1 | `public/Remove-DbaDbSchema.ps1` | ソース | メイン機能実装 |
| Get-DbaDatabase.ps1 | `public/Get-DbaDatabase.ps1` | ソース | データベースオブジェクト取得 |
| Get-DbaDbSchema.ps1 | `public/Get-DbaDbSchema.ps1` | ソース | スキーマオブジェクト取得 |
| Test-Bound.ps1 | `private/Test-Bound.ps1` | ソース | パラメータバインドチェック |
