# 機能設計書 578-Remove-DbaLogin

## 概要

本ドキュメントは、SQL Serverからログインを削除する `Remove-DbaLogin` 機能の設計仕様を定義するものです。

### 本機能の処理概要

`Remove-DbaLogin` は、SQL Serverインスタンスからログインを削除するdbatools PowerShellコマンドレットです。アクティブなセッションを持つログインの強制終了オプションや、依存関係チェックも含む包括的なログイン削除機能を提供します。

**業務上の目的・背景**：ユーザーの退職、サービスアカウントの廃止、セキュリティポリシーの変更などにより、SQL Serverからログインを削除する必要があります。アクティブなセッションを持つログインの削除は通常エラーになりますが、本機能のForceオプションにより、セッションを強制終了してから削除することが可能です。

**機能の利用シーン**：
- 従業員退職時のアカウント削除
- サービスアカウントの廃止
- テスト環境のクリーンアップ
- セキュリティ監査後の不要ログイン削除

**主要な処理内容**：
1. 対象SQL Serverインスタンスへの接続
2. 指定されたログインの検索
3. Force指定時はStop-DbaProcessでセッション終了
4. SMOのDrop()メソッドによるログイン削除
5. TEPPキャッシュからのエントリ削除

**関連システム・外部連携**：SQL Server SMOライブラリ、Get-DbaLogin、Stop-DbaProcessとの連携。

**権限による制御**：ALTER ANY LOGIN権限または同等の権限（securityadminメンバーシップ）が必要です。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| N/A | SSMSログイン管理画面 | 参照画面 | GUIでのログイン削除に相当する操作 |

## 機能種別

CRUD操作（Delete）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | Yes* | 対象のSQL Serverインスタンス（instanceパラメータセット） | 有効なインスタンス名 |
| SqlCredential | PSCredential | No | 代替認証情報 | 有効なPSCredentialオブジェクト |
| Login | String[] | Yes* | 削除対象のログイン名（instanceパラメータセット） | - |
| InputObject | Login[] | Yes* | パイプライン入力（Loginsパラメータセット） | SMO Loginオブジェクト |
| Force | Switch | No | アクティブセッションを強制終了して削除 | - |
| EnableException | Switch | No | 例外を有効化するスイッチ | - |

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

### 入力データソース

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

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | String | SQL Serverが動作するコンピュータ名 |
| InstanceName | String | SQL Serverインスタンス名 |
| SqlInstance | String | 完全なインスタンス名 |
| Login | String | 削除されたログイン名 |
| Status | String | 操作結果（"Dropped" または エラーメッセージ） |

### 出力先

- PowerShellパイプライン（PSCustomObject）

## 処理フロー

### 処理シーケンス

```
1. begin ブロック
   └─ Force指定時はConfirmPreferenceを'none'に設定
2. process ブロック
   ├─ SqlInstance指定時
   │   ├─ Connect-DbaInstanceで接続
   │   ├─ 指定ログインの検索
   │   ├─ 存在しないログインは警告
   │   └─ InputObjectに追加
   └─ InputObject処理
       ├─ Force指定時はStop-DbaProcess
       ├─ Drop()実行
       ├─ TEPPキャッシュ更新
       └─ 結果出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{Force指定?}
    B -->|Yes| C[ConfirmPreference=none]
    B -->|No| D[SqlInstance処理開始]
    C --> D
    D --> E[Connect-DbaInstance]
    E --> F{接続成功?}
    F -->|No| G[エラー出力・次へ]
    F -->|Yes| H[ログイン検索]
    H --> I{ログイン存在?}
    I -->|No| J[警告出力]
    I -->|Yes| K[InputObjectに追加]
    J --> L[ログインループ]
    K --> L
    L --> M{ShouldProcess確認}
    M -->|No| N[スキップ]
    M -->|Yes| O{Force指定?}
    O -->|Yes| P[Stop-DbaProcess]
    O -->|No| Q[Drop実行]
    P --> Q
    Q --> R{成功?}
    R -->|Yes| S[TEPPキャッシュ削除]
    S --> T[Status=Dropped]
    R -->|No| U[Status=エラー]
    T --> V[結果出力]
    U --> V
    N --> W{次のログイン?}
    V --> W
    W -->|Yes| L
    W -->|No| X{次のインスタンス?}
    G --> X
    X -->|Yes| D
    X -->|No| Y[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | アクティブセッション処理 | Force指定時はStop-DbaProcessでセッション終了 | Force指定時 |
| BR-002 | 存在確認警告 | 指定ログインが存在しない場合は警告を出力 | ログイン検索時 |
| BR-003 | TEPPキャッシュ更新 | 削除成功後にタブ補完キャッシュから削除 | 削除成功時 |

### 計算ロジック

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

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| ログイン削除 | sys.server_principals | DELETE | ログインの削除 |
| セッション終了（Force時） | - | KILL | アクティブセッションの終了 |

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

#### sys.server_principals

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| ConnectionError | 接続エラー | インスタンスへの接続失敗 | 接続情報・ネットワーク確認 |
| LoginNotFound | 検索エラー | 指定ログインが存在しない | ログイン名を確認 |
| ActiveSessions | セッションエラー | アクティブセッションがある | -Forceを使用 |
| DatabaseOwnership | 所有権エラー | データベースを所有している | データベースオーナーを変更 |

### リトライ仕様

エラー発生時はStop-Functionで処理を中断し、エラー内容を含む結果オブジェクトを出力して次のログインへ継続します。

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

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

## パフォーマンス要件

通常のログイン削除は1秒以内で完了します。Force使用時はセッション終了の待機時間が追加されます。

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

- ALTER ANY LOGIN権限が必要
- ConfirmImpact=Highによるデフォルト確認プロンプト
- Force使用時はアクティブなセッションを強制終了するため注意が必要
- 監査ログによる操作追跡を推奨

## 備考

- Get-DbaLoginとのパイプライン連携が推奨
- TEPPキャッシュはタブ補完機能のためのキャッシュ

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Login (SMO) | Microsoft.SqlServer.Management.Smo | SMOのLoginクラスの構造 |

**読解のコツ**: LoginオブジェクトはDrop()メソッドを持ち、Parentプロパティで親Serverにアクセスできます。

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

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

**主要処理フロー**:
1. **82-93行目**: パラメータ定義（2つのパラメータセット）
2. **94-96行目**: begin ブロック - Force時のConfirmPreference設定
3. **97-117行目**: SqlInstance処理とログイン検索
4. **119-148行目**: ログイン削除処理

#### Step 3: ログイン検索を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Remove-DbaLogin.ps1 | `public/Remove-DbaLogin.ps1` | ログイン検索と存在確認 |

**主要処理フロー**:
- **106行目**: `$foundLogins = $server.Logins | Where-Object { $_.Name -in $Login }`
- **110-113行目**: 存在しないログインの警告出力
- **116行目**: InputObjectへの追加

#### Step 4: 削除処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | Remove-DbaLogin.ps1 | `public/Remove-DbaLogin.ps1` | Force処理とDrop実行 |

**主要処理フロー**:
- **122-125行目**: Force指定時のStop-DbaProcess呼び出し
- **127行目**: Drop()実行
- **129行目**: Remove-TeppCacheItem（タブ補完キャッシュ更新）
- **131-137行目**: 成功時の結果オブジェクト
- **140-147行目**: 失敗時の結果オブジェクトとエラー処理

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

```
Remove-DbaLogin
    │
    ├─ begin ブロック
    │      └─ Force時ConfirmPreference設定
    │
    ├─ Connect-DbaInstance
    │
    ├─ Logins検索
    │      └─ 存在確認・警告
    │
    ├─ Stop-DbaProcess (Force時)
    │      └─ アクティブセッション終了
    │
    ├─ Login.Drop()
    │
    └─ Remove-TeppCacheItem
           └─ タブ補完キャッシュ更新
```

### データフロー図

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

SqlInstance ─────────▶ Connect-DbaInstance
        +                      │
Login[] ─────────────▶ ログイン検索 ──────────▶ Loginオブジェクト
                               │                      │
        or                     │                      │
                               │                      ▼
InputObject ───────────────────┴───────────▶ ShouldProcess確認
                                                      │
Force ─────────────────────────────────────▶ Stop-DbaProcess
                                                      │
                                              Login.Drop()
                                                      │
                                              TEPPキャッシュ更新
                                                      │
                                                      ▼
                                              PSCustomObject ──▶ パイプライン
                                              (Status: Dropped/Error)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Remove-DbaLogin.ps1 | `public/Remove-DbaLogin.ps1` | ソース | メイン関数定義 |
| Get-DbaLogin.ps1 | `public/Get-DbaLogin.ps1` | ソース | ログイン取得 |
| Stop-DbaProcess.ps1 | `public/Stop-DbaProcess.ps1` | ソース | セッション終了 |
| Connect-DbaInstance.ps1 | `public/Connect-DbaInstance.ps1` | ソース | インスタンス接続 |
| Remove-TeppCacheItem.ps1 | `private/functions/Remove-TeppCacheItem.ps1` | ソース | TEPPキャッシュ更新 |
| Stop-Function.ps1 | `private/functions/Stop-Function.ps1` | ソース | エラー処理 |
