# 画面設計書 276-更新

## 概要

本ドキュメントは、dbatoolsモジュールの更新機能（Update-Dbatools）に関する画面設計書です。

### 本画面の処理概要

dbatoolsモジュールを最新バージョンに更新するPowerShellコマンドを提供します。ただし、本機能は非推奨（deprecated）となっており、PowerShell標準のInstall-Module/Update-Moduleコマンドの使用が推奨されています。

**業務上の目的・背景**：SQL Server管理者は、dbatoolsモジュールの最新機能やバグ修正を利用するために、モジュールを定期的に更新する必要があります。以前はこのコマンドで更新を行っていましたが、現在はPowerShellGalleryとの統合が改善され、PowerShell標準のUpdate-Moduleコマンドの使用が推奨されています。

**画面へのアクセス方法**：PowerShellコンソールから`Update-Dbatools`コマンドを実行します（非推奨）。

**主要な操作・処理内容**：
1. 非推奨警告メッセージの表示
2. （以前の機能）PowerShell GalleryまたはGitHubからの最新版インストール
3. （以前の機能）古いバージョンのクリーンアップ

**画面遷移**：CLIベースのため画面遷移は存在しません。

**権限による表示制御**：モジュールのインストール先によっては管理者権限が必要な場合があります。

## 関連機能

| 機能No | 機能名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 257 | Update-Dbatools | 主機能 | dbatoolsモジュールの更新 |

## 画面種別

コマンドラインインターフェース（CLI）

## URL/ルーティング

PowerShellコマンドレット
- `Update-Dbatools`

## 入出力項目

### Update-Dbatools

| パラメータ名 | 型 | 必須 | 説明 |
|-------------|-----|------|------|
| Development | switch | No | 開発ブランチからインストール（エイリアス: dev, devbranch） |
| Cleanup | switch | No | 古いバージョンを削除 |
| EnableException | switch | No | 例外を有効化 |
| WhatIf | switch | No | 実行せずに結果を表示 |
| Confirm | switch | No | 実行前に確認 |

## 表示項目

### Update-Dbatools出力

| 項目名 | 型 | 説明 |
|--------|-----|------|
| （なし） | - | 現在は警告メッセージのみを出力 |

## イベント仕様

### 1-非推奨警告表示

Update-Dbatoolsコマンド実行時、非推奨メッセージを表示して処理を終了します。

**処理詳細**：
1. Write-Warningで非推奨メッセージを出力
2. Install-ModuleおよびUpdate-Moduleの使用を推奨

## データベース更新仕様

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

本機能はSQL Serverデータベースに対する直接的な操作は行いません。

| 操作（イベント） | 対象テーブル | 操作種別 | 概要 |
|----------------|-------------|---------|------|
| N/A | N/A | N/A | データベース操作なし |

## メッセージ仕様

| 種別 | メッセージ | 条件 |
|------|----------|------|
| Warning | This command is deprecated. Please use PowerShell's built-in commands, Install-Module and Update-Module, instead. | 常時 |

## 例外処理

| 例外条件 | 処理内容 |
|---------|---------|
| （現在の実装では例外は発生しない） | 警告メッセージのみ表示 |

## 備考

- 本コマンドは非推奨であり、将来のバージョンで削除される可能性があります
- 代わりに以下のコマンドを使用してください：
  - `Update-Module dbatools` - 既存インストールの更新
  - `Install-Module dbatools` - 新規インストール
  - `Install-Module dbatools -Force` - 強制再インストール
- 開発版をインストールする場合は、GitHubから直接インストールする方法を参照してください
- SupportsShouldProcessが実装されているがWrite-Warning後に処理が終了するため機能しない

---

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

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

### 推奨読解順序

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

本コマンドは現在、単純な警告メッセージを出力するだけであり、複雑なデータ構造は存在しません。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Update-Dbatools.ps1 | `public/Update-Dbatools.ps1` | コマンドの構造と非推奨メッセージを理解 |

**読解のコツ**: 現在の実装は警告メッセージの出力のみであり、以前の更新ロジックは削除されています。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Update-Dbatools.ps1 | `public/Update-Dbatools.ps1` | コマンド実行時の動作 |

**主要処理フロー**:
1. **60行目**: Write-Warningで非推奨メッセージを出力
2. （処理終了）

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

```
Update-Dbatools
    │
    └─ Write-Warning "This command is deprecated..."
           │
           └─ （処理終了）
```

### データフロー図

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

（パラメータ無視） ─────▶ Write-Warning ────────────────────▶ 警告メッセージ
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Update-Dbatools.ps1 | `public/Update-Dbatools.ps1` | ソース | 更新コマンド（非推奨） |
