# 機能設計書 576-Remove-DbaDbUser

## 概要

本ドキュメントは、SQL Serverデータベースからユーザーを削除する `Remove-DbaDbUser` 機能の設計仕様を定義するものです。

### 本機能の処理概要

`Remove-DbaDbUser` は、SQL Serverデータベースからユーザーを削除するdbatools PowerShellコマンドレットです。スキーマ所有権の処理を自動的に行い、依存関係の問題を解決しながらユーザーを安全に削除します。Azure SQL Databaseにも対応しており、環境に応じた処理を行います。

**業務上の目的・背景**：ユーザーの退職、プロジェクト終了、セキュリティポリシーの変更などにより、データベースからユーザーを削除する必要があります。単純なDROP USERは、スキーマ所有権によりエラーになることがありますが、本機能はこれを自動的に処理します。

**機能の利用シーン**：
- 従業員退職時のアクセス権限削除
- プロジェクト終了時のユーザークリーンアップ
- データベース移行後のユーザー整理
- セキュリティ監査後のユーザー削除

**主要な処理内容**：
1. 対象SQL Serverインスタンスへの接続またはパイプライン入力の受け取り
2. Get-DbaDbUserによるユーザーオブジェクトの取得
3. スキーマ所有権の確認（Azure SQL Databaseでは別方式）
4. 同名スキーマの削除または所有権のdboへの移譲
5. SMOのDrop()メソッドによるユーザー削除

**関連システム・外部連携**：SQL Server SMOライブラリ、Get-DbaDbUser、Azure SQL Database対応。

**権限による制御**：ALTER ANY USER権限またはdb_ownerロールメンバーシップが必要。スキーマ所有権の変更にはALTER SCHEMA権限も必要です。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| N/A | SSMSデータベースユーザー管理画面 | 参照画面 | GUIでのユーザー削除に相当する操作 |

## 機能種別

CRUD操作（Delete）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | Yes* | 対象のSQL Serverインスタンス（Userパラメータセット） | 有効なインスタンス名 |
| SqlCredential | PSCredential | No | 代替認証情報 | 有効なPSCredentialオブジェクト |
| Database | Object[] | No | 対象データベース | - |
| ExcludeDatabase | Object[] | No | 除外データベース | - |
| User | Object[] | Yes* | 削除対象ユーザー名（Userパラメータセット） | - |
| InputObject | User[] | Yes* | パイプライン入力（Objectパラメータセット） | SMO Userオブジェクト |
| Force | Switch | No | 強制削除フラグ | - |
| EnableException | Switch | No | 例外を有効化するスイッチ | - |

*UserパラメータセットまたはObjectパラメータセットのいずれかが必須

### 入力データソース

- PowerShellコマンドライン入力
- パイプライン入力（Get-DbaDbUserからの出力）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | String | SQL Serverが動作するコンピュータ名 |
| InstanceName | String | SQL Serverインスタンス名 |
| SqlInstance | String | 完全なインスタンス名 |
| Database | String | データベース名 |
| User | User | 削除されたユーザーオブジェクト |
| Status | String | 操作結果（"Dropped" または "Not Dropped"） |

### 出力先

- PowerShellパイプライン（PSCustomObject）

## 処理フロー

### 処理シーケンス

```
1. begin ブロック
   ├─ Force指定時はConfirmPreferenceを'none'に設定
   └─ パイプライン入力コレクションを初期化
2. process ブロック
   ├─ InputObject → コレクションに追加
   └─ SqlInstance指定時 → Get-DbaDbUserでユーザー取得・処理
3. end ブロック
   └─ パイプライン入力されたユーザーを処理
4. Remove-DbUser 内部関数
   ├─ Azure SQL判定
   ├─ スキーマ所有権確認
   ├─ スキーマ処理（Drop or Alter）
   └─ User.Drop()実行
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{InputObject指定?}
    B -->|Yes| C[コレクションに追加]
    B -->|No| D[SqlInstance処理]
    D --> E[Connect-DbaInstance]
    E --> F[Get-DbaDbUser]
    F --> G[ユーザーフィルタ]
    G --> H[Remove-DbUser呼び出し]
    C --> I[end ブロック]
    H --> I
    I --> J[Remove-DbUser実行]
    J --> K{Azure SQL?}
    K -->|Yes| L[T-SQLでスキーマ取得]
    K -->|No| M[EnumOwnedObjects]
    L --> N[スキーマ処理]
    M --> N
    N --> O{スキーマあり?}
    O -->|No| P[User.Drop]
    O -->|Yes| Q{同名スキーマ?}
    Q -->|Yes| R{オブジェクトあり?}
    R -->|No| S[Schema.Drop]
    R -->|Yes| T[警告・スキップ]
    Q -->|No| U{オブジェクトあり?}
    U -->|No| V[Owner=dbo設定]
    U -->|Yes| W{Force指定?}
    W -->|Yes| V
    W -->|No| X[警告・スキップ]
    S --> P
    V --> P
    P --> Y{成功?}
    Y -->|Yes| Z[Status=Dropped]
    Y -->|No| AA[Status=Not Dropped]
    Z --> AB[結果出力]
    AA --> AB
    T --> AC{次のユーザー?}
    X --> AC
    AB --> AC
    AC -->|Yes| J
    AC -->|No| AD[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | Azure SQL対応 | Azure SQLではInvoke-DbaQueryでスキーマを取得 | DatabaseEngineType=SqlAzureDatabase |
| BR-002 | 同名スキーマ削除 | ユーザーと同名の空スキーマは削除 | スキーマにオブジェクトがない場合 |
| BR-003 | スキーマオーナー移譲 | その他のスキーマはdboに移譲 | オブジェクトなし、またはForce指定時 |
| BR-004 | オブジェクト所有警告 | オブジェクトを所有している場合は警告 | ユーザーがオブジェクトを所有 |
| BR-005 | end ブロック処理 | パイプライン処理の"Collection was modified"エラー回避のためendブロックで削除 | InputObject使用時 |

### 計算ロジック

特に計算ロジックはありません。

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| スキーマオーナー変更 | sys.schemas | UPDATE | スキーマのprincipal_idを更新 |
| スキーマ削除 | sys.schemas | DELETE | 空スキーマの削除 |
| ユーザー削除 | sys.database_principals | DELETE | ユーザーの削除 |

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

#### sys.database_principals

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| DELETE | principal_id | 対象ユーザーのID | SMO Drop()で実行 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| ConnectionError | 接続エラー | インスタンスへの接続失敗 | 接続情報・ネットワーク確認 |
| SchemaOwnsObjects | 依存エラー | スキーマにオブジェクトが存在 | -Forceを使用 |
| UserOwnsObjects | オブジェクト所有 | ユーザーがオブジェクトを所有 | オブジェクトを先に削除 |

### リトライ仕様

エラー発生時はStatus="Not Dropped"で結果を出力し、次のユーザーへ継続します。

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

SMOのDrop()およびAlter()メソッドによる暗黙的トランザクションで処理されます。

## パフォーマンス要件

通常のユーザー削除は1秒以内で完了します。Azure SQL DatabaseではT-SQLクエリの実行時間が追加されます。

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

- ALTER ANY USER権限が必要
- スキーマオーナー変更にはALTER SCHEMA権限が必要
- ConfirmImpact=Mediumによる確認プロンプト
- 監査ログによる操作追跡を推奨

## 備考

- Azure SQL Database対応
- Get-DbaDbUserとのパイプライン連携が可能
- end ブロックでの一括削除により、パイプライン処理時のエラーを回避

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | User (SMO) | Microsoft.SqlServer.Management.Smo | SMOのUserクラスとEnumOwnedObjects() |
| 1-2 | Schema (SMO) | Microsoft.SqlServer.Management.Smo | SMOのSchemaクラス |

**読解のコツ**: EnumOwnedObjects()はUserが所有するオブジェクトのURNを返します。Azure SQLでは使用できないため、T-SQLで代替します。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Remove-DbaDbUser.ps1 | `public/Remove-DbaDbUser.ps1` | 関数定義とパラメータバインディング |

**主要処理フロー**:
1. **98-116行目**: パラメータ定義（2つのパラメータセット）
2. **118-123行目**: begin ブロック - 内部関数定義開始
3. **123-235行目**: Remove-DbUser 内部関数
4. **238-265行目**: process ブロック
5. **268-271行目**: end ブロック

#### Step 3: 内部関数Remove-DbUserを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Remove-DbaDbUser.ps1 | `public/Remove-DbaDbUser.ps1` | スキーマ処理とユーザー削除 |

**主要処理フロー**:
- **138-155行目**: Azure SQL Database判定とスキーマ取得
- **157-191行目**: スキーマ所有権処理
- **195-232行目**: スキーマ処理実行とユーザー削除

#### Step 4: Azure SQL対応を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | Remove-DbaDbUser.ps1 | `public/Remove-DbaDbUser.ps1` | Azure SQL用のT-SQLクエリ |

**主要処理フロー**:
- **138行目**: DatabaseEngineType判定
- **139-151行目**: Invoke-DbaQueryでスキーマを取得
- **153-155行目**: オンプレミス用EnumOwnedObjects()

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

```
Remove-DbaDbUser
    │
    ├─ begin ブロック
    │      └─ Remove-DbUser 内部関数定義
    │
    ├─ process ブロック
    │      ├─ InputObject → コレクション追加
    │      │
    │      └─ SqlInstance指定時
    │             ├─ Connect-DbaInstance
    │             ├─ Get-DbaDbUser
    │             └─ Remove-DbUser呼び出し
    │
    └─ end ブロック
           └─ Remove-DbUser (パイプライン入力処理)
                  │
                  ├─ Invoke-DbaQuery (Azure SQL)
                  │
                  ├─ User.EnumOwnedObjects() (オンプレミス)
                  │
                  ├─ Schema.Alter() / Schema.Drop()
                  │
                  └─ User.Drop()
```

### データフロー図

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

SqlInstance ─────────▶ Connect-DbaInstance
        +                      │
Database ────────────▶ Get-DbaDbUser ─────────▶ ユーザーコレクション
        +                                              │
User ────────────────────────────────────────────────▶ フィルタ
                                                       │
        or                                             │
                                                       ▼
InputObject ────────────────────────────────▶ Remove-DbUser
                                                       │
                                               Azure SQL判定
                                                       │
                                               スキーマ所有権確認
                                                       │
                                               Schema.Alter/Drop
                                                       │
                                               User.Drop()
                                                       │
                                                       ▼
                                               PSCustomObject ──▶ パイプライン
                                               (Status: Dropped/Not Dropped)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Remove-DbaDbUser.ps1 | `public/Remove-DbaDbUser.ps1` | ソース | メイン関数定義 |
| Get-DbaDbUser.ps1 | `public/Get-DbaDbUser.ps1` | ソース | ユーザー取得 |
| Invoke-DbaQuery.ps1 | `public/Invoke-DbaQuery.ps1` | ソース | T-SQLクエリ実行（Azure SQL用） |
| Connect-DbaInstance.ps1 | `public/Connect-DbaInstance.ps1` | ソース | インスタンス接続 |
| Stop-Function.ps1 | `private/functions/Stop-Function.ps1` | ソース | エラー処理 |
| Write-Message.ps1 | `private/functions/Write-Message.ps1` | ソース | メッセージ出力 |
