# 機能設計書 536-Set-DbaDbSchema

## 概要

本ドキュメントは、dbatools PowerShellモジュールにおけるSet-DbaDbSchema機能の設計仕様を定義するものである。この機能はデータベーススキーマの所有者を変更し、セキュリティとオブジェクト所有権の責任を再割り当てする。

### 本機能の処理概要

**業務上の目的・背景**：データベースセキュリティの再編成、開発者からサービスアカウントへの所有権移転、マイグレーション後のスキーマ所有権標準化など、スキーマ所有者の変更が必要なシナリオは多い。本機能は、SMOを使用してスキーマのOwnerプロパティを更新し、データベースに変更を適用する。

**機能の利用シーン**：
- 開発者からサービスアカウントへの所有権移転
- マイグレーション後の所有権標準化
- セキュリティポリシー変更に伴う所有者変更
- アプリケーションユーザーへのスキーマ割り当て
- db_ownerロールへの所有権集約

**主要な処理内容**：
1. SqlInstance指定時のDatabaseパラメータ必須チェック
2. Get-DbaDatabase経由でのデータベースオブジェクト取得
3. Get-DbaDbSchema経由でのスキーマオブジェクト取得
4. Ownerプロパティの設定
5. Alter()メソッドによる変更適用
6. 更新済みスキーマオブジェクトの出力

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

**権限による制御**：
- 対象スキーマに対するCONTROL権限またはALTER ANY SCHEMA権限
- 新しい所有者がデータベースに存在するプリンシパルであること

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 39 | スキーマ管理 | 補助機能 | データベーススキーマの設定変更 |

## 機能種別

データ更新処理（UPDATE / ALTER）

## 入力仕様

### 入力パラメータ

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

### 入力データソース

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

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | SQL Serverをホストするコンピュータ名（デフォルト表示） |
| InstanceName | string | SQL Serverインスタンス名（デフォルト表示） |
| SqlInstance | string | 完全修飾SQL Serverインスタンス名（デフォルト表示） |
| Name | string | スキーマ名（デフォルト表示） |
| IsSystemObject | boolean | システムスキーマかどうか（デフォルト表示） |
| Owner | string | 新しい所有者（更新後の値） |
| DatabaseName | string | データベース名（追加プロパティ） |
| DatabaseId | int | データベースID（追加プロパティ） |

### 出力先

- 標準出力（Microsoft.SqlServer.Management.Smo.Schema）
- パイプライン出力

## 処理フロー

### 処理シーケンス

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

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

3. データベースループ処理
   └─ スキーマループ処理
       ├─ ShouldProcess確認
       ├─ Get-DbaDbSchemaでスキーマオブジェクト取得
       ├─ Ownerプロパティ設定
       ├─ Alter()メソッド実行
       └─ 更新済みスキーマオブジェクト出力
```

### フローチャート

```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[Owner = SchemaOwner]
    M --> N[Alter実行]
    N --> O{成功?}
    O -->|No| P[エラー出力]
    O -->|Yes| Q[スキーマ出力]
    P --> R{次のスキーマ?}
    K --> R
    Q --> R
    R -->|Yes| I
    R -->|No| S{次のDB?}
    S -->|Yes| H
    S -->|No| T[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | DB必須条件 | SqlInstance指定時はDatabase必須 | SqlInstance指定時 |
| BR-002 | スキーマ必須 | Schemaパラメータは必須 | 常時 |
| BR-003 | 所有者必須 | SchemaOwnerパラメータは必須 | 常時 |
| BR-004 | 有効な所有者 | SchemaOwnerはデータベースに存在するプリンシパルであること | 常時 |

### 計算ロジック

特になし

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| スキーマ所有者変更 | sys.schemas | UPDATE | principal_idカラム更新 |

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

#### sys.schemas

SMO Schema.Alter()メソッド経由で以下相当のDDLが実行される：
```sql
ALTER AUTHORIZATION ON SCHEMA::[スキーマ名] TO [新所有者]
```

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | パラメータ不足 | SqlInstance指定時にDatabase未指定 | Databaseパラメータを指定 |
| - | 所有者不正 | SchemaOwnerがDB内に存在しない | 有効なユーザー/ロールを指定 |
| - | 権限不足 | ALTER権限なし | 必要な権限を付与 |

### リトライ仕様

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

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

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

## パフォーマンス要件

- スキーマ所有者変更は通常即座に完了
- 多数のスキーマを一括変更する場合は順次処理

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

- CONTROL権限またはALTER ANY SCHEMA権限が必要
- スキーマ所有者変更はセキュリティ境界の変更を意味する
- 変更後のスキーマ内オブジェクトへのアクセス権限に影響する可能性

## 備考

- スキーマ所有者を変更しても、スキーマ内のオブジェクト所有者は変わらない
- Get-DbaDbSchemaで取得したスキーマオブジェクトに対して直接Owner設定とAlter()呼び出しも可能

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Set-DbaDbSchema.ps1 | `public/Set-DbaDbSchema.ps1` | 出力オブジェクト（SMO Schema）- 124行目で直接出力 |

**読解のコツ**: Get-DbaDbSchemaで取得したオブジェクトを変更して出力しているため、追加プロパティはGet-DbaDbSchema由来。

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

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

**主要処理フロー**:
1. **104行目**: processブロック開始
2. **106-109行目**: SqlInstance指定時のDatabase必須チェック
3. **111-113行目**: Get-DbaDatabase呼び出し
4. **115-131行目**: データベース/スキーマループと所有者変更処理

#### Step 3: 所有者変更ロジックを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Set-DbaDbSchema.ps1 | `public/Set-DbaDbSchema.ps1` | 119-128行目のスキーマ所有者変更処理 |

**主要処理フロー**:
- **119行目**: ShouldProcess確認
- **121行目**: Get-DbaDbSchemaでスキーマオブジェクト取得
- **122行目**: Ownerプロパティ設定
- **123行目**: Alter()メソッド実行
- **124行目**: 更新済みスキーマ出力

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

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

### データフロー図

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

SqlInstance ─────────▶ Get-DbaDatabase ───────────▶ Database[]
      +                       │
Database ────────────────────┤
      or                      │
InputObject ─────────────────┤
                              ▼
Schema[] ────────────▶ Get-DbaDbSchema ───────────▶ Schema Object
                              │
SchemaOwner ─────────────────┤
                              ▼
                       Owner = SchemaOwner
                              │
                              ▼
                       Alter() ────────────────────▶ SMO Schema
                                                     (with updated Owner)
```

### 関連ファイル一覧

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