# 機能設計書 503-New-DbaAgentSchedule

## 概要

本ドキュメントは、SQL Server Agent スケジュールを新規作成する `New-DbaAgentSchedule` コマンドの機能設計書である。

### 本機能の処理概要

**業務上の目的・背景**：SQL Server Agent ジョブの実行タイミングを定義するスケジュールは、運用自動化の中核を担う。本コマンドは、スケジュールの作成を自動化し、複数のジョブに同じスケジュールを共有させることで、一貫したジョブ実行タイミングの管理を実現する。手動での SSMS 操作や T-SQL 実行を置き換え、スケジュールパラメータの包括的なバリデーションを提供する。

**機能の利用シーン**：定期的なバックアップジョブの実行スケジュール設定、メンテナンスウィンドウの定義、複数ジョブへの共通スケジュール適用、毎時・毎分の監視ジョブ設定、月次・週次の定期処理スケジュール構築などに利用される。

**主要な処理内容**：
1. FrequencyText パラメータによる自然言語風スケジュール定義のパース
2. FrequencyType（Once/Daily/Weekly/Monthly/MonthlyRelative等）の整数値変換
3. FrequencyInterval のビットマスク変換（曜日、日付等）
4. FrequencySubdayType/Interval の検証（時間内繰り返し設定）
5. 開始/終了日時の検証とフォーマット変換
6. SMO（JobSchedule クラス）を使用したスケジュール作成
7. 指定ジョブへの共有スケジュール割り当て（Job パラメータ指定時）
8. 作成されたスケジュールの出力（Get-DbaAgentSchedule経由）

**関連システム・外部連携**：SQL Server Agent サービス、msdb データベース、関連する SQL Server Agent ジョブ

**権限による制御**：対象インスタンスで sysadmin 権限または SQLAgentOperatorRole が必要。Owner パラメータでスケジュールの所有者を指定可能。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 14 | Agentスケジュール管理 | 主画面 | SQLエージェントスケジュールの新規作成 |

## 機能種別

CRUD操作（Create）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | Yes | 対象SQL Serverインスタンス | 接続可能なインスタンス名 |
| SqlCredential | PSCredential | No | 代替認証情報 | - |
| Job | object[] | No | スケジュールを割り当てるジョブ | 存在するジョブ名 |
| Schedule | object | Yes* | スケジュール名 | *FrequencyText未指定時は必須 |
| Disabled | switch | No | 無効状態で作成 | - |
| FrequencyType | string | No | 頻度タイプ | Once/OneTime/Daily/Weekly/Monthly/MonthlyRelative/AgentStart/AutoStart/IdleComputer/OnIdle |
| FrequencyInterval | object[] | No | 頻度間隔（曜日/日付） | FrequencyTypeに応じた値 |
| FrequencySubdayType | string | No | 日内頻度タイプ | Once/Time/Seconds/Second/Minutes/Minute/Hours/Hour |
| FrequencySubdayInterval | int | No | 日内頻度間隔 | Seconds:10-59, Minutes:1-59, Hours:1-23 |
| FrequencyRelativeInterval | string | No | 相対間隔 | First/Second/Third/Fourth/Last/Unused |
| FrequencyRecurrenceFactor | int | No | 繰り返し係数 | Weekly/Monthly/MonthlyRelative時に1以上 |
| FrequencyText | string | No | 自然言語風スケジュール定義 | 正規表現でパース |
| StartDate | string | No | 開始日 | yyyyMMdd形式 |
| EndDate | string | No | 終了日 | yyyyMMdd形式 |
| StartTime | string | No | 開始時刻 | HHmmss形式 |
| EndTime | string | No | 終了時刻 | HHmmss形式 |
| Owner | string | No | スケジュール所有者 | 有効なログイン名 |
| Force | switch | No | 既定値適用・既存削除 | - |
| EnableException | switch | No | 例外を有効化 | - |

### 入力データソース

PowerShell コマンドラインからのパラメータ入力

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | SQL Serverインスタンスのコンピュータ名 |
| InstanceName | string | SQL Serverインスタンス名 |
| SqlInstance | string | 完全なSQL Serverインスタンス名 |
| Name | string | スケジュール名 |
| IsEnabled | bool | スケジュールの有効状態 |
| FrequencyTypes | enum | 頻度タイプ |
| NextRunDate | DateTime | 次回実行日時 |
| LastRunDate | DateTime | 前回実行日時 |

### 出力先

PowerShell パイプライン（Microsoft.SqlServer.Management.Smo.Agent.JobSchedule オブジェクト）

## 処理フロー

### 処理シーケンス

```
1. beginブロック
   ├─ Forceパラメータ指定時、ConfirmPreferenceを'none'に設定
   ├─ FrequencyTextのパース（指定時）
   │   └─ 正規表現でinterval/unit/startを抽出し各パラメータに変換
   ├─ FrequencyType/Interval/SubdayType の整数値変換
   ├─ 日付・時刻パラメータの検証とDateTime/TimeSpan変換
   └─ 各種バリデーション（interval範囲、recurrence factor等）
2. processブロック（各インスタンスに対して）
   ├─ インスタンス接続
   ├─ JobScheduleオブジェクト作成
   ├─ スケジュールプロパティ設定
   │   ├─ IsEnabled
   │   ├─ FrequencyInterval
   │   ├─ FrequencyTypes
   │   ├─ FrequencySubDayTypes/Interval
   │   ├─ FrequencyRelativeIntervals
   │   ├─ FrequencyRecurrenceFactor
   │   ├─ ActiveStartDate/EndDate
   │   ├─ ActiveStartTimeOfDay/EndTimeOfDay
   │   └─ OwnerLoginName
   ├─ JobSchedule.Create() 実行
   ├─ Jobパラメータ指定時のジョブへの割り当て
   │   └─ Job.AddSharedSchedule() 実行
   └─ Get-DbaAgentSchedule で結果取得・出力
3. endブロック
   └─ 完了メッセージ出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{FrequencyText指定?}
    B -->|Yes| C[FrequencyTextをパース]
    C --> D[各パラメータに変換]
    B -->|No| E{Schedule名指定?}
    D --> E
    E -->|No| F[エラー終了]
    E -->|Yes| G[FrequencyType整数変換]
    G --> H[FrequencyInterval計算]
    H --> I[日付・時刻検証]
    I --> J{検証成功?}
    J -->|No| F
    J -->|Yes| K[インスタンス接続]
    K --> L[JobScheduleオブジェクト作成]
    L --> M[プロパティ設定]
    M --> N[Create実行]
    N --> O{Job指定?}
    O -->|Yes| P[AddSharedSchedule実行]
    O -->|No| Q[結果出力]
    P --> Q
    Q --> R[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-503-01 | スケジュール名必須 | Schedule パラメータまたは FrequencyText のいずれかが必要 | 常時 |
| BR-503-02 | Daily間隔範囲 | Daily 頻度では FrequencyInterval は 1-365 または EveryDay | FrequencyType=Daily |
| BR-503-03 | 繰り返し係数必須 | Weekly/Monthly/MonthlyRelative では FrequencyRecurrenceFactor が 1 以上必要 | 該当FrequencyType時 |
| BR-503-04 | Subday秒間隔 | Seconds タイプでは間隔は 10-59 秒 | FrequencySubdayType=Seconds |
| BR-503-05 | Subday分間隔 | Minutes タイプでは間隔は 1-59 分 | FrequencySubdayType=Minutes |
| BR-503-06 | Subday時間隔 | Hours タイプでは間隔は 1-23 時間 | FrequencySubdayType=Hours |
| BR-503-07 | 終了日制約 | 終了日は開始日以降である必要がある | EndDate指定時 |
| BR-503-08 | Force既定値 | Force 指定時、未設定の日付・時刻に既定値を適用 | Force指定時 |

### 計算ロジック

**FrequencyTypeの整数変換**：
- Once/OneTime = 1
- Daily = 4
- Weekly = 8
- Monthly = 16
- MonthlyRelative = 32
- AgentStart/AutoStart = 64
- IdleComputer/OnIdle = 128

**Weekly FrequencyIntervalのビットマスク**：
- Sunday = 1, Monday = 2, Tuesday = 4, Wednesday = 8
- Thursday = 16, Friday = 32, Saturday = 64
- Weekdays = 62, Weekend = 65, EveryDay = 127

**MonthlyRelative FrequencyIntervalの値**：
- Sunday = 1, Monday = 2, Tuesday = 3, Wednesday = 4
- Thursday = 5, Friday = 6, Saturday = 7
- Day = 8, Weekdays = 9, WeekendDay = 10

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| スケジュール作成 | msdb.dbo.sysschedules | INSERT | SMO経由でスケジュールレコード作成 |
| ジョブ割り当て | msdb.dbo.sysjobschedules | INSERT | ジョブへの共有スケジュール割り当て |

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

#### msdb.dbo.sysschedules

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| INSERT | name | Schedule パラメータ値 | スケジュール名 |
| INSERT | enabled | Disabled スイッチの逆 | 有効/無効 |
| INSERT | freq_type | FrequencyType 整数値 | 頻度タイプ |
| INSERT | freq_interval | FrequencyInterval 計算値 | 頻度間隔 |
| INSERT | freq_subday_type | FrequencySubdayType 整数値 | 日内頻度タイプ |
| INSERT | freq_subday_interval | FrequencySubdayInterval 値 | 日内頻度間隔 |
| INSERT | active_start_date | StartDate のYYYYMMDD | 開始日 |
| INSERT | active_end_date | EndDate のYYYYMMDD | 終了日 |
| INSERT | active_start_time | StartTime のHHMMSS | 開始時刻 |
| INSERT | active_end_time | EndTime のHHMMSS | 終了時刻 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | パラメータエラー | FrequencyText パース失敗 | Stop-Function で終了 |
| - | パラメータエラー | Schedule 名未指定 | Stop-Function で終了 |
| - | パラメータエラー | 日付形式不正 | Stop-Function で終了 |
| - | パラメータエラー | 時刻形式不正 | Stop-Function で終了 |
| - | パラメータエラー | 終了日が開始日より前 | Stop-Function で終了 |
| - | パラメータエラー | Subday 間隔が範囲外 | Stop-Function で終了 |
| - | 接続エラー | インスタンスへの接続失敗 | Stop-Function で処理継続 |
| - | 作成エラー | スケジュール作成失敗 | Stop-Function で処理継続 |
| - | AG関連エラー | AGリスナー経由での作成試行 | 専用エラーメッセージで継続 |

### リトライ仕様

リトライ処理は実装されていない。

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

SMO の JobSchedule.Create() メソッドによる暗黙的トランザクション。

## パフォーマンス要件

特に定義されていない。

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

- 対象インスタンスへの sysadmin 権限または SQLAgentOperatorRole が必要
- Owner パラメータでスケジュール所有者を指定可能
- スケジュール変更権限は所有者と sysadmin に限定される

## 備考

- SQL Server 2000 以降をサポート
- FrequencyText による自然言語風定義をサポート（例："Every 5 minutes", "Every sunday at 02:00:00"）
- 共有スケジュールとして作成され、複数ジョブに割り当て可能
- 可用性グループリスナー経由での作成はサポートされない

---

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

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

### 推奨読解順序

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

SMO の JobSchedule クラスと FrequencyTypes 列挙型を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | New-DbaAgentSchedule.ps1 | `public/New-DbaAgentSchedule.ps1` | 426-465行目: FrequencyType/SubdayType/RelativeInterval の整数変換 |

**読解のコツ**: 各パラメータは文字列で受け取り、整数値に変換してSMOに渡す。

#### Step 2: FrequencyText パース処理を理解する

自然言語風スケジュール定義のパース。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | New-DbaAgentSchedule.ps1 | `public/New-DbaAgentSchedule.ps1` | 377-411行目: FrequencyText の正規表現パース |

**主要処理フロー**:
1. **378行目**: 正規表現パターン定義
2. **379-396行目**: interval/unit/start の抽出と変換
3. **402-406行目**: Schedule 名未指定時は FrequencyText を使用

#### Step 3: FrequencyInterval 計算を理解する

曜日や日付のビットマスク計算。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | New-DbaAgentSchedule.ps1 | `public/New-DbaAgentSchedule.ps1` | 497-590行目: FrequencyType別のInterval計算 |

**主要処理フロー**:
- **497-504行目**: Daily 頻度の Interval 設定
- **507-545行目**: Weekly 頻度のビットマスク計算
- **548-558行目**: Monthly 頻度の日付設定
- **561-590行目**: MonthlyRelative 頻度の設定

#### Step 4: スケジュール作成処理を理解する

メインの作成ロジック。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | New-DbaAgentSchedule.ps1 | `public/New-DbaAgentSchedule.ps1` | 679-790行目: process/endブロック |

**主要処理フロー**:
- **690-703行目**: JobSchedule オブジェクト作成（AGリスナーエラー処理含む）
- **706-758行目**: スケジュールプロパティ設定
- **760行目**: Create() 実行
- **771-779行目**: Job への AddSharedSchedule 実行
- **783行目**: Get-DbaAgentSchedule で結果取得

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

```
New-DbaAgentSchedule
    │
    ├─ Connect-DbaInstance (684行目)
    │      └─ SQL Server インスタンスへの接続確立
    │
    ├─ New-Object Microsoft.SqlServer.Management.Smo.Agent.JobSchedule (695行目)
    │      └─ SMO JobSchedule オブジェクト作成
    │
    ├─ $jobschedule.Create() (760行目)
    │      └─ スケジュールの永続化
    │
    ├─ Get-DbaAgentJob (772行目)
    │      └─ Job パラメータ指定時のジョブ取得
    │
    ├─ $j.AddSharedSchedule() (776行目)
    │      └─ ジョブへの共有スケジュール割り当て
    │
    ├─ Add-TeppCacheItem (769行目)
    │      └─ タブ補完キャッシュへの追加
    │
    └─ Get-DbaAgentSchedule (783行目)
           └─ 作成結果の取得と出力
```

### データフロー図

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

FrequencyText   ─────▶ 正規表現パース ─────▶ FrequencyType/Interval/StartTime
                              │
SqlInstance     ─────▶ Connect-DbaInstance ─────▶ Server オブジェクト
                              │
Schedule        ─────────────▶├─▶ スケジュール名設定
FrequencyType   ─────────────▶├─▶ 整数変換 (1/4/8/16/32/64/128)
FrequencyInterval ───────────▶├─▶ ビットマスク計算
StartDate/Time  ─────────────▶├─▶ DateTime/TimeSpan 変換
                              ▼
                      JobSchedule オブジェクト作成
                              │
                              ▼
                      Create() 実行
                              │
Job             ─────────────▶├─▶ AddSharedSchedule() (指定時)
                              │
                              ▼
                      Get-DbaAgentSchedule ─────▶ JobSchedule オブジェクト
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| New-DbaAgentSchedule.ps1 | `public/New-DbaAgentSchedule.ps1` | ソース | メインコマンド実装 |
| Get-DbaAgentSchedule.ps1 | `public/Get-DbaAgentSchedule.ps1` | ソース | スケジュール取得、結果出力 |
| Get-DbaAgentJob.ps1 | `public/Get-DbaAgentJob.ps1` | ソース | ジョブ取得（割り当て時） |
| Connect-DbaInstance.ps1 | `public/Connect-DbaInstance.ps1` | ソース | インスタンス接続 |
