# 機能設計書 581-Rename-DbaLogin

## 概要

本ドキュメントは、dbatools PowerShellモジュールの`Rename-DbaLogin`コマンドレットに関する機能設計書です。本機能はSQL Serverログインの名前変更を行い、オプションで関連するデータベースユーザーも一括で名前変更することができます。

### 本機能の処理概要

`Rename-DbaLogin`は、SQL Serverインスタンスレベルでログイン名を変更し、マイグレーションやドメイン変更、命名規則の改善などの一般的な課題を解決します。

**業務上の目的・背景**：企業のActive Directoryドメイン変更、組織再編によるアカウント名変更、命名規則の標準化など、ログイン名を変更する必要がある場面は多々あります。手動でログイン名を変更し、全てのデータベースユーザーマッピングを更新するのは時間がかかりエラーが発生しやすい作業です。本機能はこれらを単一の操作で安全に実行できます。

**機能の利用シーン**：
- 異なる環境間でのログインマイグレーション時
- Active Directoryドメインの変更に伴うWindows認証ログインの更新
- 命名規則の標準化（例：プレフィックスやサフィックスの追加）
- 企業合併やシステム統合時のアカウント整理

**主要な処理内容**：
1. 指定されたSQL Serverインスタンスへの接続
2. 変更対象のログインの存在確認
3. SMOを使用したログイン名の変更（`$currentLogin.Rename($NewLogin)`）
4. `-Force`オプション指定時、関連する全データベースユーザーの名前変更
5. ユーザー名変更失敗時のロールバック処理

**関連システム・外部連携**：SQL Server Management Objects (SMO) を使用してログインとユーザーの操作を実行します。

**権限による制御**：sysadmin権限が必要です。SQL Server 2000以上に対応しています。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 65 | ログイン管理 | 補助機能 | ログインのリネーム |

## 機能種別

CRUD操作（Update） / データ変更

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | Yes | 対象となるSQL Serverインスタンス | sysadmin権限が必要 |
| SqlCredential | PSCredential | No | SQL Server接続用の代替資格情報 | Windows認証、SQL認証、AD認証に対応 |
| Login | string | Yes | 変更対象の既存ログイン名 | 存在するログイン名と完全一致が必要 |
| NewLogin | string | Yes | 変更後の新しいログイン名 | Windowsログインの場合、同じSIDに解決される必要あり |
| Force | switch | No | 関連する全データベースユーザーも同時に名前変更 | - |
| EnableException | switch | No | 例外をスローするモードに切り替え | - |

### 入力データソース

- SQL Serverインスタンスのログイン情報（`$server.Logins[$Login]`）
- データベースユーザーマッピング情報（`$currentLogin.EnumDatabaseMappings()`）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | SQL Serverインスタンスのコンピュータ名 |
| InstanceName | string | SQL Serverインスタンス名 |
| SqlInstance | string | 完全なSQL Serverインスタンス名（computer\instance） |
| Database | string | ユーザー名変更対象のデータベース名（ログイン変更時はnull） |
| PreviousLogin | string | 元のログイン名（ログイン変更時のみ） |
| NewLogin | string | 新しいログイン名（ログイン変更時のみ） |
| PreviousUser | string | 元のデータベースユーザー名（ユーザー変更時のみ） |
| NewUser | string | 新しいデータベースユーザー名（ユーザー変更成功時のみ） |
| Status | string | 操作結果（Successful, Failure, Failure to rename. Rolled back change.） |

### 出力先

PowerShellパイプラインへのPSCustomObjectの出力

## 処理フロー

### 処理シーケンス

```
1. SQL Serverインスタンスへの接続
   └─ Connect-DbaInstanceを使用して接続を確立

2. アクセス可能なデータベースの取得
   └─ $server.Databases | Where-Object IsAccessible

3. ログインの存在確認
   └─ $server.Logins[$Login]で対象ログインを取得
   └─ 存在しない場合はエラー終了

4. ログイン名の変更
   └─ ShouldProcessによる確認
   └─ EnumDatabaseMappings()でデータベースマッピングを取得
   └─ $currentLogin.Rename($NewLogin)でログイン名を変更

5. Forceオプション時のユーザー名変更
   └─ 各データベースマッピングをループ
   └─ $user.Rename($NewLogin)でユーザー名を変更
   └─ 失敗時は$currentLogin.Rename($Login)でロールバック

6. 結果の出力
   └─ PSCustomObjectとして操作結果を出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[Connect-DbaInstance]
    B --> C{接続成功?}
    C -->|No| D[エラー出力]
    C -->|Yes| E[ログイン存在確認]
    E --> F{ログイン存在?}
    F -->|No| G[ログインなしエラー]
    F -->|Yes| H[EnumDatabaseMappings取得]
    H --> I[ログイン名変更]
    I --> J{変更成功?}
    J -->|No| K[失敗結果出力]
    J -->|Yes| L{Force指定?}
    L -->|No| M[成功結果出力]
    L -->|Yes| N[各データベースユーザーループ]
    N --> O[ユーザー名変更]
    O --> P{変更成功?}
    P -->|No| Q[ログイン名ロールバック]
    Q --> R[ロールバック結果出力]
    P -->|Yes| S[成功結果追加]
    S --> T{次のユーザー?}
    T -->|Yes| N
    T -->|No| M
    M --> U[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-581-01 | ログイン存在確認 | 変更対象のログインが存在しない場合は処理を中止 | 常時 |
| BR-581-02 | ロールバック処理 | Forceオプションでユーザー名変更に失敗した場合、ログイン名をロールバック | Force指定時 |
| BR-581-03 | SID整合性 | Windowsログインの場合、新しい名前は同じSIDに解決される必要がある | Windowsログイン変更時 |

### 計算ロジック

特になし

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| ログイン名変更 | sys.server_principals | UPDATE | SMO経由でログイン名を変更 |
| ユーザー名変更 | sys.database_principals | UPDATE | SMO経由でデータベースユーザー名を変更 |

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

#### sys.server_principals

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| UPDATE | name | $NewLogin | SMO経由で変更 |

#### sys.database_principals

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| UPDATE | name | $NewLogin | Force指定時のみ |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ConnectionError | SQL Server接続失敗 | Stop-Functionでエラー出力 |
| - | TargetError | ログインが存在しない | Stop-Functionでエラー出力、処理をスキップ |
| - | RenameError | ログイン名変更失敗 | Status=Failureで出力 |
| - | UserRenameError | データベースユーザー名変更失敗 | ログイン名をロールバックしてStatus出力 |

### リトライ仕様

リトライ処理なし。エラー発生時は即座に中断またはロールバック。

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

明示的なトランザクション管理なし。ただし、Forceオプション使用時にユーザー名変更が失敗した場合は、ログイン名を元の名前にロールバックする擬似的なトランザクション動作を実装しています。

## パフォーマンス要件

特に規定なし。データベース数が多い場合、Forceオプション使用時は処理時間が増加します。

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

- sysadmin権限が必須
- SQL Server 2000以上に対応
- SupportsShouldProcess実装によるWhatIf/Confirmサポート

## 備考

- SQL Server Management Objects (SMO) を使用してログイン操作を実行
- パイプライン出力に対応し、複数インスタンスの一括処理が可能

---

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

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

### 推奨読解順序

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

まず、出力されるPSCustomObjectの構造と、SMOのLoginオブジェクトの構造を理解することが重要です。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Rename-DbaLogin.ps1 | `public/Rename-DbaLogin.ps1` | 125-135行目: 出力PSCustomObjectの構造定義 |

**読解のコツ**: PSCustomObjectは動的に作成され、ComputerName、InstanceName、SqlInstance、Database、PreviousLogin、NewLogin、PreviousUser、NewUser、Statusの9プロパティを持ちます。

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

処理の起点となるfunction定義とパラメータを確認します。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Rename-DbaLogin.ps1 | `public/Rename-DbaLogin.ps1` | 92-103行目: パラメータ定義、1行目: function宣言 |

**主要処理フロー**:
1. **92-103行目**: パラメータ定義（SqlInstance、Login、NewLoginが必須）
2. **105行目**: processブロック開始、foreachでインスタンスループ

#### Step 3: 接続とログイン検索処理

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Rename-DbaLogin.ps1 | `public/Rename-DbaLogin.ps1` | 107-118行目: 接続とログイン存在確認 |

**主要処理フロー**:
- **107-111行目**: Connect-DbaInstanceによる接続
- **113行目**: アクセス可能なデータベース取得
- **114行目**: `$server.Logins[$Login]`でログイン取得
- **116-118行目**: ログイン存在確認、なければエラー

#### Step 4: ログイン名変更処理

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | Rename-DbaLogin.ps1 | `public/Rename-DbaLogin.ps1` | 120-151行目: ログイン名変更のメイン処理 |

**主要処理フロー**:
- **120行目**: ShouldProcessによる確認
- **123行目**: `EnumDatabaseMappings()`でマッピング取得
- **124行目**: `$currentLogin.Rename($NewLogin)`でログイン名変更
- **125-135行目**: 成功時のPSCustomObject出力
- **136-150行目**: 失敗時のエラー処理

#### Step 5: Forceオプション時のユーザー名変更

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 5-1 | Rename-DbaLogin.ps1 | `public/Rename-DbaLogin.ps1` | 153-196行目: データベースユーザー名の一括変更 |

**主要処理フロー**:
- **153行目**: Forceフラグのチェック
- **154-155行目**: データベースマッピングのループ
- **156-157行目**: ユーザーの存在確認
- **163行目**: `$user.Rename($NewLogin)`でユーザー名変更
- **175-191行目**: 失敗時のロールバック処理（`$currentLogin.Rename($Login)`）

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

```
Rename-DbaLogin
    │
    ├─ Connect-DbaInstance
    │      └─ SQL Server接続確立
    │
    ├─ $server.Logins[$Login]
    │      └─ SMOログインオブジェクト取得
    │
    ├─ $currentLogin.EnumDatabaseMappings()
    │      └─ データベースユーザーマッピング取得
    │
    ├─ $currentLogin.Rename($NewLogin)
    │      └─ ログイン名変更
    │
    └─ $user.Rename($NewLogin)  [Force時のみ]
           └─ データベースユーザー名変更
```

### データフロー図

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

SqlInstance ───────────▶ Connect-DbaInstance ──────────▶ $server
                              │
Login ─────────────────▶ $server.Logins[$Login] ───────▶ $currentLogin
                              │
NewLogin ──────────────▶ $currentLogin.Rename() ───────▶ PSCustomObject
                              │
Force ─────────────────▶ $user.Rename()  ──────────────▶ PSCustomObject[]
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Rename-DbaLogin.ps1 | `public/Rename-DbaLogin.ps1` | ソース | メイン処理 |
| Connect-DbaInstance.ps1 | `public/Connect-DbaInstance.ps1` | ソース | SQL Server接続処理 |
