# 機能設計書 696-Start-DbaService

## 概要

本ドキュメントは、SQL Server関連のWindowsサービスを開始するdbatools PowerShellコマンド `Start-DbaService` の機能設計書です。

### 本機能の処理概要

`Start-DbaService` は、複数のコンピューターにまたがるSQL Server関連サービスを、サービス依存関係を尊重しながら適切な順序で開始する機能です。Engine、Agent、Browser、FullText、SSAS、SSIS、SSRS、PolyBase、Launchpadなど、SQL Serverの各種サービスを対象とします。

**業務上の目的・背景**：メンテナンスウィンドウ後やサーバー再起動後には、SQL Server関連サービスを適切な順序で開始する必要があります。複数のサーバーにまたがるサービス開始を、依存関係を考慮しながら効率的に実行することで、運用作業を自動化・効率化します。

**機能の利用シーン**：
- メンテナンスウィンドウ後のサービス開始
- サーバー再起動後のサービス開始
- 停止されたサービスのトラブルシューティング
- 複数サーバーの一括サービス開始

**主要な処理内容**：
1. 対象サービスの取得（Get-DbaService呼び出しまたはパイプライン入力）
2. InstanceName/Typeによるフィルタリング
3. サービスの開始処理（Update-ServiceStatus -Action start）
4. 処理結果の出力

**関連システム・外部連携**：Windows Service Control Manager、SQL Server関連Windowsサービス

**権限による制御**：対象コンピューターでのローカル管理者権限が必要

## 関連画面

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

## 機能種別

サービス管理 / 操作実行

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| ComputerName | DbaInstanceParameter[] | No | サービス開始対象のコンピューター名 | Serverパラメータセット、デフォルト$env:COMPUTERNAME |
| InstanceName | string[] | No | 特定のSQL Serverインスタンス名でフィルタリング | なし |
| SqlInstance | DbaInstanceParameter[] | No | コンピューター名とインスタンス名の組み合わせで指定 | Serverパラメータセット |
| Credential | PSCredential | No | 代替資格情報でコンピューターに接続 | なし |
| Type | string[] | No | サービスタイプでフィルタリング（Agent, Browser, Engine, FullText, SSAS, SSIS, SSRS, PolyBase, Launchpad） | ValidateSet |
| InputObject | object[] | Yes (Service) | Get-DbaServiceからのサービスオブジェクト | パイプライン入力、Serviceパラメータセット |
| Timeout | int | No | 各サービス操作のタイムアウト秒数 | デフォルト60秒、0で無限待機 |
| EnableException | switch | No | 例外を有効にし、try/catchでのキャッチを可能にする | なし |
| WhatIf | switch | No | 実行せずに処理内容を表示 | なし |
| Confirm | switch | No | 実行前に確認プロンプトを表示 | なし |

### 入力データソース

- Get-DbaServiceから取得したサービスオブジェクト
- パイプライン入力

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| Name | string | サービス名 |
| DisplayName | string | サービスの表示名 |
| Status | string | サービスの状態（Running, Stopped等） |
| StartType | string | 起動タイプ |

### 出力先

PowerShellパイプライン (System.ServiceProcess.ServiceController)

## 処理フロー

### 処理シーケンス

```
1. begin ブロック
   ├─ processArray初期化
   └─ Serverパラメータセットの場合、Get-DbaServiceでサービス取得

2. process ブロック
   └─ InputObjectをprocessArrayに追加

3. end ブロック
   ├─ InstanceName/Typeでフィルタリング
   ├─ ShouldProcess確認
   ├─ Update-ServiceStatus -Action start でサービス開始
   └─ 結果を出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{Serverパラメータセット?}
    B -->|Yes| C[Get-DbaServiceでサービス取得]
    B -->|No| D[パイプラインからInputObject受信]
    C --> D
    D --> E[processArrayにサービス追加]
    E --> F[InstanceName/Typeでフィルタリング]
    F --> G{ShouldProcess?}
    G -->|No| H[終了]
    G -->|Yes| I{サービスあり?}
    I -->|No| J[警告メッセージ出力]
    I -->|Yes| K[Update-ServiceStatus start]
    J --> H
    K --> L[結果出力]
    L --> H
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | 権限要件 | ローカル管理者権限が必要 | 常時 |
| BR-002 | タイムアウト | デフォルト60秒、0で無限待機 | 常時 |
| BR-003 | サービス未検出 | 条件に一致するサービスがない場合は警告 | 常時 |

### 計算ロジック

特別な計算ロジックはありません。

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

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

本機能はデータベースを直接操作しませんが、SQL Serverサービスの開始によりデータベースへのアクセスが可能になります。

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| N/A | N/A | サービス操作 | SQL Serverサービスの開始 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| N/A | サービス開始失敗 | サービス開始がタイムアウトまたはエラー | サービスのイベントログを確認 |
| ObjectNotFound | サービス未検出 | 指定条件に一致するサービスがない | パラメータ条件を確認 |
| N/A | 権限エラー | ローカル管理者権限がない場合 | 適切な資格情報でCredentialパラメータを使用 |

### リトライ仕様

明示的なリトライ機能は実装されていません。

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

サービス操作はトランザクション的ではありません。

## パフォーマンス要件

- デフォルトタイムアウト: 60秒
- 複数サービスの開始は順次処理

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

- 対象コンピューターでのローカル管理者権限が必要
- Credentialパラメータによる代替資格情報のサポート
- ShouldProcess/Confirmによる実行前確認

## 備考

- サービスが既に実行中の場合、操作はスキップされます
- 無効化されたサービスは開始できません

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Get-DbaService出力 | (Get-DbaService参照) | ServiceName, ServiceType, InstanceName, ComputerName などのプロパティ構造 |

**読解のコツ**: Start-DbaServiceは Get-DbaService から取得したサービスオブジェクトを処理します。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Start-DbaService.ps1 | `public/Start-DbaService.ps1` | メイン関数の構造、パラメータ定義 |

**主要処理フロー**:
1. **108-125行目**: パラメータ定義（2つのパラメータセット: Server, Service）
2. **126-137行目**: begin ブロック - Serverパラメータセットの場合にGet-DbaService呼び出し
3. **138-141行目**: process ブロック - InputObjectをprocessArrayに追加
4. **142-158行目**: end ブロック - メイン処理
5. **143行目**: フィルタリング処理
6. **145-156行目**: サービス開始処理

#### Step 3: 依存関数を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Get-DbaService.ps1 | `public/Get-DbaService.ps1` | サービス情報取得 |
| 3-2 | Update-ServiceStatus.ps1 | `private/functions/Update-ServiceStatus.ps1` | 実際のサービス操作 |

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

```
Start-DbaService
    │
    ├─ Get-DbaService (135行目, Serverパラメータセット)
    │      └─ サービス情報を取得
    │
    └─ Update-ServiceStatus (146-153行目)
           └─ -Action start: サービス開始
```

### データフロー図

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

ComputerName ───▶ Get-DbaService ───▶ サービスオブジェクト
                         │
InstanceName ───▶ フィルタリング
                         │
Type ───────────▶        │
                         ▼
InputObject ─────────▶ processArray
                         │
                         ▼
                  Update-ServiceStatus (start) ───▶ 開始結果
                         │
                         ▼
                  ServiceController オブジェクト
                  (Name, DisplayName, Status, StartType)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Start-DbaService.ps1 | `public/Start-DbaService.ps1` | ソース | メイン機能実装 |
| Get-DbaService.ps1 | `public/Get-DbaService.ps1` | ソース | サービス情報取得 |
| Update-ServiceStatus.ps1 | `private/functions/Update-ServiceStatus.ps1` | ソース | サービス操作実行 |
| Start-DbaService.Tests.ps1 | `tests/Start-DbaService.Tests.ps1` | テスト | テストコード |
