# 機能設計書 222-Set-DbaDbState

## 概要

本ドキュメントは、SQL Serverデータベースの読み書きアクセス、オンライン状態、ユーザーアクセスモードを変更するdbatools PowerShellコマンドレット「Set-DbaDbState」の機能設計書である。

### 本機能の処理概要

Set-DbaDbStateは、ALTER DATABASE文を使用してデータベースのアクセスモードと可用性状態を変更するコマンドレットである。読み書きアクセス（READ_ONLY/READ_WRITE）、オンライン状態（ONLINE/OFFLINE/EMERGENCY）、ユーザーアクセス（SINGLE_USER/RESTRICTED_USER/MULTI_USER）、およびデータベースのデタッチを実行できる。

**業務上の目的・背景**：データベース管理において、メンテナンス作業やトラブルシューティングのためにデータベースの状態を変更する必要が頻繁に発生する。例えば、レポーティングデータベースをREAD_ONLYにする、メンテナンス中にSINGLE_USERモードにする、破損からの復旧のためにEMERGENCYモードにするなどの場面がある。この機能により、手動でT-SQLを記述する必要なく、これらの状態変更を効率的に行える。

**機能の利用シーン**：
- データベースをREAD_ONLYに設定してレポーティング専用にする場合
- メンテナンス作業のためSINGLE_USERモードで排他アクセスを確保する場合
- データベースをOFFLINEにしてファイル移動やハードウェア作業を行う場合
- 破損したデータベースをEMERGENCYモードで緊急復旧を試みる場合
- 可用性グループやミラーリングからデータベースを安全にデタッチする場合

**主要な処理内容**：
1. 指定されたSQL Serverインスタンスへの接続確立
2. 対象データベースの現在状態取得
3. 指定されたオプションに基づく状態変更の実行
4. -Forceオプション時は接続の強制切断とトランザクションのロールバック
5. ミラーリング/AG環境でのデタッチ時の事前処理
6. 変更結果の出力

**関連システム・外部連携**：SQL Server Management Objects (SMO) を介してSQL Serverと連携。可用性グループおよびデータベースミラーリングとの連携もある。

**権限による制御**：ALTER DATABASE権限またはデータベース所有者権限が必要。デタッチにはsp_detach_dbの実行権限が必要。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | コマンドライン | 主画面 | PowerShellコンソールからの直接実行 |

## 機能種別

データベース状態変更（UPDATE操作）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | Yes（Serverパラメータセット） | 対象SQL Serverインスタンス | 有効なインスタンス名 |
| SqlCredential | PSCredential | No | 認証用資格情報 | - |
| Database | object[] | No | 対象データベース名 | - |
| ExcludeDatabase | object[] | No | 除外データベース名 | - |
| AllDatabases | switch | No | 全データベース対象フラグ | - |
| ReadOnly | switch | No | READ_ONLYモード設定 | 排他グループ |
| ReadWrite | switch | No | READ_WRITEモード設定 | 排他グループ |
| Online | switch | No | ONLINEステータス設定 | 排他グループ |
| Offline | switch | No | OFFLINEステータス設定 | 排他グループ |
| Emergency | switch | No | EMERGENCYモード設定 | 排他グループ |
| Detached | switch | No | デタッチ実行 | 排他グループ |
| SingleUser | switch | No | SINGLE_USERアクセス設定 | 排他グループ |
| RestrictedUser | switch | No | RESTRICTED_USERアクセス設定 | 排他グループ |
| MultiUser | switch | No | MULTI_USERアクセス設定 | 排他グループ |
| Force | switch | No | 強制実行（接続切断・ロールバック） | - |
| EnableException | switch | No | 例外有効化フラグ | - |
| InputObject | PSCustomObject[] | Yes（Databaseパラメータセット） | パイプライン入力 | - |

### 入力データソース

- PowerShellコマンドライン入力
- Get-DbaDatabase、Get-DbaDbStateからのパイプライン入力

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | SQL Serverホストコンピュータ名 |
| InstanceName | string | SQL Serverインスタンス名 |
| SqlInstance | string | 完全なSQL Serverインスタンス名 |
| DatabaseName | string | データベース名 |
| RW | string | 読み書きアクセスモード（READ_ONLY/READ_WRITE） |
| Status | string | データベースステータス（ONLINE/OFFLINE/EMERGENCY/DETACHED） |
| Access | string | ユーザーアクセスモード（SINGLE_USER/RESTRICTED_USER/MULTI_USER） |
| Notes | string | エラー詳細（失敗時）またはnull |
| Database | object | SMO Databaseオブジェクト（デフォルト非表示） |

### 出力先

PowerShellパイプライン（標準出力）

## 処理フロー

### 処理シーケンス

```
1. パラメータ検証
   └─ 排他的パラメータの組み合わせチェック
   └─ ReadOnly/ReadWrite、Online/Offline/Emergency/Detached、SingleUser/RestrictedUser/MultiUser

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

3. データベース対象の特定
   └─ システムデータベース（master, model, msdb, tempdb, distribution）を除外
   └─ -Database/-ExcludeDatabase条件でフィルタリング

4. 各データベースに対する処理ループ
   └─ 現在の状態をGet-DbaDbStateで取得
   └─ スナップショットの場合はスキップ

5. 状態変更の実行
   └─ 各スイッチパラメータに応じたALTER DATABASE実行
   └─ -Force時はWITH ROLLBACK IMMEDIATE使用

6. デタッチ処理（-Detached指定時）
   └─ スナップショット存在チェック
   └─ ミラーリング解除（-Force時）
   └─ AG除去（-Force時）
   └─ OFFLINE設定後sp_detach_db実行

7. 結果の出力
   └─ PSCustomObjectで状態変更結果を返却
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[パラメータ検証]
    B --> C{排他パラメータ<br/>組み合わせOK?}
    C -->|No| D[エラー終了]
    C -->|Yes| E[SQL Server接続]
    E --> F[データベース一覧取得]
    F --> G[システムDB除外・フィルタ]
    G --> H{対象DB存在?}
    H -->|No| I[警告出力・終了]
    H -->|Yes| J[各DBに対してループ]
    J --> K{スナップショット?}
    K -->|Yes| L[スキップ]
    K -->|No| M[現在状態取得]
    M --> N{ReadOnly指定?}
    N -->|Yes| O[READ_ONLY設定]
    N -->|No| P{ReadWrite指定?}
    P -->|Yes| Q[READ_WRITE設定]
    P -->|No| R{他オプション処理...}
    R --> S{Detached指定?}
    S -->|Yes| T[デタッチ処理]
    S -->|No| U[結果出力]
    O --> U
    Q --> U
    T --> U
    U --> V{次のDB?}
    L --> V
    V -->|Yes| J
    V -->|No| W[終了]
    D --> W
    I --> W
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | システムDB除外 | master, model, msdb, tempdb, distributionは対象外 | 常時 |
| BR-002 | スナップショット除外 | データベーススナップショットは状態変更不可 | DatabaseSnapshotBaseName存在時 |
| BR-003 | RW排他 | ReadOnlyとReadWriteは同時指定不可 | パラメータ検証時 |
| BR-004 | Status排他 | Online, Offline, Emergency, Detachedは同時指定不可 | パラメータ検証時 |
| BR-005 | Access排他 | SingleUser, RestrictedUser, MultiUserは同時指定不可 | パラメータ検証時 |
| BR-006 | デタッチ時Force必須 | ミラーリング/AG環境ではForceが必要 | IsMirroringEnabled or AvailabilityGroupName存在時 |
| BR-007 | デタッチ前OFFLINE | デタッチ前にOFFLINE状態にする | Detached指定時 |
| BR-008 | スナップショット元デタッチ不可 | スナップショットが存在するDBはデタッチ不可 | スナップショット存在時 |

### 計算ロジック

該当なし

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| 状態変更 | sys.databases | UPDATE（間接） | ALTER DATABASE文による設定変更 |
| デタッチ | sys.databases | DELETE（間接） | sp_detach_dbによる削除 |

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

#### sys.databases

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| UPDATE | is_read_only | 0 or 1 | READ_WRITE/READ_ONLY設定時 |
| UPDATE | state | 0-6 | ONLINE/OFFLINE/EMERGENCY設定時 |
| UPDATE | user_access | 0-2 | MULTI_USER/SINGLE_USER/RESTRICTED_USER設定時 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ConnectionError | SQL Server接続失敗 | 接続情報を確認して再実行 |
| - | InvalidArgument | 排他パラメータの同時指定 | 1つのオプションのみ指定 |
| - | Blocked | 接続がブロック中 | -Forceパラメータを使用 |
| - | SnapshotExists | デタッチ対象にスナップショットあり | 先にスナップショットを削除 |
| - | MirrorActive | ミラーリング中DBのデタッチ | -Forceでミラーリング解除 |

### リトライ仕様

リトライ処理は実装されていない。-Forceオプションにより接続のロールバックとキルを強制実行。

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

- ALTER DATABASE文は暗黙的なトランザクションで実行
- -Force時はWITH ROLLBACK IMMEDIATEでオープントランザクションを強制ロールバック
- デタッチはsp_detach_db内部でトランザクション処理

## パフォーマンス要件

特に定義されていない。ただし、-Forceなしの場合はNO_WAITオプションを使用し、ブロック時は即座に失敗する。

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

- ALTER DATABASE権限が必要
- デタッチにはsp_detach_db実行権限が必要
- -Forceは他ユーザーの接続を強制切断するため慎重に使用

## 備考

- EMERGENCYモードはデータベース破損時の緊急復旧用
- SINGLE_USERモードでは1つの接続のみ許可
- WhatIfとConfirmパラメータをサポート

---

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

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

### 推奨読解順序

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

内部ヘルパー関数と出力オブジェクトの構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Set-DbaDbState.ps1 | `public/Set-DbaDbState.ps1` | 出力オブジェクトの構造（109-122行目の.OUTPUTSセクション） |
| 1-2 | Set-DbaDbState.ps1 | `public/Set-DbaDbState.ps1` | statusHashハッシュテーブル（221-225行目） |

**読解のコツ**: beginブロック内のヘルパー関数（Get-WrongCombo, Edit-DatabaseState, Get-DbState）に注目。

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

パラメータ検証とメイン処理ループを理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Set-DbaDbState.ps1 | `public/Set-DbaDbState.ps1` | beginブロック（178-260行目）- パラメータ検証 |
| 2-2 | Set-DbaDbState.ps1 | `public/Set-DbaDbState.ps1` | processブロック（261-537行目）- メイン処理 |

**主要処理フロー**:
1. **181-191行目**: Get-WrongCombo関数 - 排他パラメータチェック
2. **193-219行目**: Edit-DatabaseState関数 - ALTER DATABASE実行
3. **227-236行目**: Get-DbState関数 - 状態正規化
4. **238-259行目**: 排他パラメータグループの検証

#### Step 3: 状態変更ロジックを理解する

各状態変更オプションの処理を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Set-DbaDbState.ps1 | `public/Set-DbaDbState.ps1` | ReadOnly/ReadWrite処理（319-347行目） |
| 3-2 | Set-DbaDbState.ps1 | `public/Set-DbaDbState.ps1` | Online/Offline/Emergency処理（349-391行目） |
| 3-3 | Set-DbaDbState.ps1 | `public/Set-DbaDbState.ps1` | SingleUser/RestrictedUser/MultiUser処理（393-433行目） |

#### Step 4: デタッチ処理を理解する

デタッチ時の特殊処理（ミラーリング/AG対応）を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | Set-DbaDbState.ps1 | `public/Set-DbaDbState.ps1` | デタッチ処理（435-495行目） |

**主要処理フロー**:
- **439-444行目**: スナップショット存在チェック
- **445-450行目**: ミラーリング/AG時のForce要件チェック
- **452-463行目**: ミラーリング解除処理
- **465-475行目**: AG除去処理
- **479-494行目**: OFFLINE化とsp_detach_db実行

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

```
Set-DbaDbState
    │
    ├─ begin {}
    │      ├─ Get-WrongCombo (内部関数)
    │      ├─ Edit-DatabaseState (内部関数)
    │      └─ Get-DbState (内部関数)
    │
    ├─ Connect-DbaInstance
    │      └─ SQL Server SMO接続
    │
    ├─ Get-DbaDbState
    │      └─ 現在状態取得
    │
    ├─ Edit-DatabaseState (各状態変更で呼び出し)
    │      ├─ $server.KillAllProcesses() (-Force時)
    │      └─ $server.Query() (ALTER DATABASE実行)
    │
    ├─ $db.ChangeMirroringState() (ミラーリング解除)
    │
    ├─ $server.AvailabilityGroups[].AvailabilityDatabases[].Drop() (AG除去)
    │
    └─ sp_detach_db (デタッチ)
```

### データフロー図

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

SqlInstance ─────────┐
Database/AllDatabases┤
ReadOnly/ReadWrite ──┼──▶ パラメータ検証
Online/Offline/etc ──┤    (Get-WrongCombo)
SingleUser/MultiUser─┤          │
Force ───────────────┘          ▼
                         Connect-DbaInstance
                               │
                               ▼
                         Get-DbaDbState ──▶ 現在状態取得
                               │
                               ▼
                         Edit-DatabaseState
                         (ALTER DATABASE)
                               │
                               ▼
                         [デタッチ時]
                         ├─ ミラーリング解除
                         ├─ AG除去
                         └─ sp_detach_db
                               │
                               ▼
                         PSCustomObject ────▶ RW, Status, Access, Notes
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Set-DbaDbState.ps1 | `public/Set-DbaDbState.ps1` | ソース | メインコマンドレット実装 |
| Get-DbaDbState.ps1 | `public/Get-DbaDbState.ps1` | ソース | データベース状態取得 |
| Connect-DbaInstance.ps1 | `public/Connect-DbaInstance.ps1` | ソース | SQL Server接続処理 |
