# 機能設計書 223-Set-DbaDefaultPath

## 概要

本ドキュメントは、SQL Serverインスタンスのデフォルトファイルパス（データ、ログ、バックアップ）を設定するdbatools PowerShellコマンドレット「Set-DbaDefaultPath」の機能設計書である。

### 本機能の処理概要

Set-DbaDefaultPathは、SQL Serverインスタンスで新規データベース作成時やバックアップ実行時にデフォルトで使用されるファイルパスを設定するコマンドレットである。データファイル、ログファイル、バックアップファイルの格納先ディレクトリを変更でき、ファイルパスの標準化や環境間での一貫性確保に役立つ。

**業務上の目的・背景**：SQL Serverの導入時や環境構築時に、データベースファイルやバックアップの格納先を適切に設定することは重要である。パフォーマンス最適化のためにデータとログを別ドライブに配置したり、ストレージ管理ポリシーに従ったパス設定を行ったりする必要がある。この機能により、複数インスタンスに対して一貫したパス設定を効率的に適用できる。

**機能の利用シーン**：
- SQL Server新規インストール後のデフォルトパス設定
- ストレージ構成変更に伴うパス移行
- 複数インスタンス間でのパス設定標準化
- 環境間（開発/本番）でのパス設定一括変更

**主要な処理内容**：
1. 指定されたSQL Serverインスタンスへの接続確立
2. 指定パスのアクセス可能性検証（Test-DbaPath）
3. SMOサーバーオブジェクトのプロパティ設定
4. Alter()メソッドによる変更の適用
5. 変更結果の出力

**関連システム・外部連携**：SQL Server Management Objects (SMO) を介してSQL Serverと連携する。Azure SQL Databaseはサポートされない。

**権限による制御**：サーバーレベルのALTER SETTINGS権限またはsysadmin固定サーバーロールが必要。

## 関連画面

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

## 機能種別

サーバー設定変更（UPDATE操作）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | Yes | 対象SQL Serverインスタンス | 有効なインスタンス名 |
| SqlCredential | PSCredential | No | 認証用資格情報 | - |
| Type | string[] | No | パスの種類（Data, Log, Backup） | ValidateSet |
| Path | string | Yes | 設定するディレクトリパス | Test-DbaPathで検証 |
| EnableException | switch | No | 例外有効化フラグ | - |

### 入力データソース

- PowerShellコマンドライン入力
- パイプライン入力（SqlInstanceプロパティ経由）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | SQL Serverホストコンピュータ名 |
| InstanceName | string | SQL Serverインスタンス名（ServiceName） |
| SqlInstance | string | 完全なSQL Serverインスタンス名 |
| Data | string | データファイルのデフォルトパス |
| Log | string | ログファイルのデフォルトパス |
| Backup | string | バックアップファイルのデフォルトパス |

### 出力先

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

## 処理フロー

### 処理シーケンス

```
1. SQL Serverインスタンスへの接続
   └─ Connect-DbaInstanceを使用（AzureUnsupportedフラグ付き）

2. パスの正規化
   └─ 末尾の空白と\を削除

3. パスのアクセス可能性検証
   └─ Test-DbaPathで指定パスを検証
   └─ アクセス不可の場合はエラー

4. パス種別に応じた設定
   └─ Data: $server.DefaultFile
   └─ Log: $server.DefaultLog
   └─ Backup: $server.BackupDirectory

5. 変更の適用
   └─ $server.Alter()で変更をコミット

6. 警告メッセージ出力（Data/Log変更時）
   └─ SQL Serverサービス再起動が必要な旨を通知

7. 結果の出力
   └─ PSCustomObjectで現在の設定を返却
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[SQL Server接続]
    B --> C{接続成功?}
    C -->|No| D[エラー出力・継続]
    C -->|Yes| E[パス正規化]
    E --> F[Test-DbaPath実行]
    F --> G{パスアクセス可能?}
    G -->|No| H[エラー出力・継続]
    G -->|Yes| I{Data指定?}
    I -->|Yes| J[DefaultFile設定]
    I -->|No| K{Log指定?}
    J --> K
    K -->|Yes| L[DefaultLog設定]
    K -->|No| M{Backup指定?}
    L --> M
    M -->|Yes| N[BackupDirectory設定]
    M -->|No| O[Alter実行]
    N --> O
    O --> P{Data/Log変更?}
    P -->|Yes| Q[再起動警告出力]
    P -->|No| R[結果出力]
    Q --> R
    R --> S[終了]
    D --> S
    H --> S
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | Azure非対応 | Azure SQL Databaseは非対応 | Connect-DbaInstance AzureUnsupported |
| BR-002 | パス検証 | 設定前にパスのアクセス可能性を検証 | 常時 |
| BR-003 | パス正規化 | 末尾空白とバックスラッシュを除去 | 常時 |
| BR-004 | 再起動必須 | Data/Log変更時はSQL Server再起動が必要 | Type = Data or Log |
| BR-005 | Backup即時反映 | Backupパス変更は即座に反映 | Type = Backup |

### 計算ロジック

該当なし

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| パス変更 | レジストリ/システムテーブル | UPDATE（間接） | SMO Alter()による設定変更 |

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

SMOを介した設定変更であり、直接のテーブル操作はない。設定はSQL Serverレジストリキーに保存される。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ConnectionError | SQL Server接続失敗 | 接続情報を確認して再実行 |
| - | PathNotAccessible | 指定パスにアクセス不可 | 有効なパスを指定 |
| - | AzureNotSupported | Azure SQL Database指定 | オンプレミスまたはIaaS環境を使用 |
| - | AlterFailed | 設定変更の適用失敗 | 権限を確認 |

### リトライ仕様

リトライ処理は実装されていない。エラー発生時はStop-Functionで処理を停止し、-Continueにより次のインスタンスに進む。

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

SMOのAlter()メソッドにより設定変更が適用される。内部的にSQL Serverが設定をレジストリに書き込む。

## パフォーマンス要件

特に定義されていない。設定変更は軽量な操作である。

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

- ALTER SETTINGS権限またはsysadminロールが必要
- 指定パスはSQL Serverサービスアカウントからアクセス可能である必要がある
- UNCパスの場合はネットワーク権限も必要

## 備考

- Data/Logパスの変更はSQL Serverサービス再起動後に有効になる
- エラーログのパス変更にはSet-DbaStartupParameterを使用
- WhatIfとConfirmパラメータをサポート

---

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

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

### 推奨読解順序

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

出力オブジェクトの構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Set-DbaDefaultPath.ps1 | `public/Set-DbaDefaultPath.ps1` | 出力オブジェクトの構造（55-68行目の.OUTPUTSセクション） |

**読解のコツ**: シンプルな構造で、PSCustomObjectを直接返却している。

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

processブロック内のメイン処理を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Set-DbaDefaultPath.ps1 | `public/Set-DbaDefaultPath.ps1` | processブロック（92-143行目） |

**主要処理フロー**:
1. **93-98行目**: 各SqlInstanceに対するループとConnect-DbaInstance接続
2. **100行目**: パスの正規化（Trim, TrimEnd）
3. **102-104行目**: Test-DbaPathによるパス検証
4. **106-122行目**: Type別のプロパティ設定
5. **124-141行目**: Alter()実行と結果出力

#### Step 3: パス設定ロジックを理解する

各パスタイプの設定処理を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Set-DbaDefaultPath.ps1 | `public/Set-DbaDefaultPath.ps1` | Data/Log/Backup設定（106-122行目） |

**主要処理フロー**:
- **106-110行目**: Data指定時 - $server.DefaultFile設定
- **112-116行目**: Log指定時 - $server.DefaultLog設定
- **118-122行目**: Backup指定時 - $server.BackupDirectory設定

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

```
Set-DbaDefaultPath
    │
    ├─ Connect-DbaInstance (接続確立)
    │      └─ SQL Server SMO接続
    │      └─ AzureUnsupportedフラグでAzure排除
    │
    ├─ Test-DbaPath (パス検証)
    │      └─ SQL Serverからのパスアクセス可能性確認
    │
    └─ $server.Alter() (SMOメソッド)
           └─ 設定変更の適用
```

### データフロー図

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

SqlInstance ─────────┐
SqlCredential ───────┤
Type (Data/Log/Backup)┼──▶ Connect-DbaInstance ──▶ SMO Server
Path ────────────────┘         │
                               ▼
                        パス正規化
                        (Trim, TrimEnd)
                               │
                               ▼
                        Test-DbaPath ──▶ パス検証
                               │
                               ▼
                        プロパティ設定
                        ├─ DefaultFile
                        ├─ DefaultLog
                        └─ BackupDirectory
                               │
                               ▼
                        $server.Alter() ──▶ PSCustomObject
                                           (Data, Log, Backup)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Set-DbaDefaultPath.ps1 | `public/Set-DbaDefaultPath.ps1` | ソース | メインコマンドレット実装 |
| Get-DbaDefaultPath.ps1 | `public/Get-DbaDefaultPath.ps1` | ソース | デフォルトパス取得（関連機能） |
| Test-DbaPath.ps1 | `public/Test-DbaPath.ps1` | ソース | パスアクセス可能性検証 |
| Connect-DbaInstance.ps1 | `public/Connect-DbaInstance.ps1` | ソース | SQL Server接続処理 |
