# 機能設計書 622-Remove-DbaDbSequence

## 概要

本ドキュメントは、dbatools PowerShellモジュールの`Remove-DbaDbSequence`コマンドレットに関する機能設計書である。このコマンドレットは、SQL Serverデータベースからシーケンスオブジェクトを削除する機能を提供する。

### 本機能の処理概要

**業務上の目的・背景**：データベースのメンテナンスやアプリケーション変更に伴い、不要になったシーケンスオブジェクトを削除する必要がある。この機能により、DBAはPowerShellから効率的に単一または複数のシーケンスを一括削除でき、スキーマの整理とデータベースオブジェクトのクリーンアップが可能になる。

**機能の利用シーン**：
- アプリケーションの廃止に伴うシーケンスのクリーンアップ
- テスト環境のシーケンス一括削除
- データベースのリファクタリング時のオブジェクト整理
- 使用されなくなったシーケンスの特定と削除

**主要な処理内容**：
1. 対象SQL Serverインスタンスへの接続確立
2. 指定されたシーケンスオブジェクトの取得（Get-DbaDbSequence経由）
3. ShouldProcess確認（ConfirmImpact: High）
4. シーケンスオブジェクトのDrop()メソッド実行
5. 削除結果（成功/失敗）の出力

**関連システム・外部連携**：SQL Server Management Objects (SMO)を使用してSQL Serverと連携する。

**権限による制御**：シーケンス削除にはデータベース内でのDROP権限またはシーケンスの所有権が必要。

## 関連画面

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

## 機能種別

CRUD操作（Delete）/ DDL実行

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | 条件付き | 対象SQL Serverインスタンス（NonPipelineセット必須） | 有効なインスタンス名 |
| SqlCredential | PSCredential | No | SQL Server接続用資格情報 | - |
| Database | string[] | No | 対象データベース名 | ワイルドカード使用可 |
| Sequence | string[] | No | 削除対象シーケンス名 | ワイルドカード使用可 |
| Schema | string[] | No | 対象スキーマ名 | ワイルドカード使用可 |
| InputObject | Sequence[] | 条件付き | パイプライン入力用シーケンスオブジェクト（Pipelineセット必須） | - |
| EnableException | switch | No | 例外処理モード切替 | - |

### 入力データソース

- PowerShellコマンドラインからのパラメータ入力
- パイプラインからのGet-DbaDbSequence出力

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | SQL Serverホスト名 |
| InstanceName | string | インスタンス名 |
| SqlInstance | string | 完全インスタンス名 |
| Database | string | データベース名 |
| Sequence | string | 完全修飾シーケンス名（schema.name形式） |
| SequenceName | string | シーケンス名（スキーマなし） |
| SequenceSchema | string | スキーマ名 |
| Status | string | 削除結果（Dropped/エラーメッセージ） |
| IsRemoved | bool | 削除成功フラグ |

### 出力先

PowerShellパイプライン（PSCustomObject）

## 処理フロー

### 処理シーケンス

```
1. begin ブロック
   └─ 空の配列 $sequences を初期化
2. process ブロック
   └─ SqlInstance指定時: Get-DbaDbSequenceでシーケンス取得
   └─ パイプライン入力時: InputObjectを$sequencesに追加
3. end ブロック（削除実行）
   └─ 3.1 foreach sequenceItemでループ
   └─ 3.2 ShouldProcess確認
   └─ 3.3 出力オブジェクト初期化
   └─ 3.4 Drop()メソッド実行
   └─ 3.5 成功時: Status="Dropped", IsRemoved=$true
   └─ 3.6 失敗時: Status=エラーメッセージ, IsRemoved=$false
   └─ 3.7 結果出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{SqlInstance指定?}
    B -->|Yes| C[Get-DbaDbSequence実行]
    C --> D[sequences配列に追加]
    B -->|No| E[InputObjectを配列に追加]
    E --> D
    D --> F[end ブロック]
    F --> G[foreach sequenceItem]
    G --> H[ShouldProcess確認]
    H -->|No| G
    H -->|Yes| I[出力オブジェクト作成]
    I --> J[Drop実行]
    J --> K{成功?}
    K -->|Yes| L[Status=Dropped]
    K -->|No| M[Status=エラー]
    L --> N[IsRemoved設定]
    M --> N
    N --> O[結果出力]
    O --> G
    G --> P[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | 高影響確認 | ConfirmImpact='High'のためデフォルトで確認プロンプト表示 | 常時 |
| BR-002 | endブロック削除 | パイプライン入力時の"Collection was modified"エラー回避のためendブロックで削除 | パイプライン入力時 |
| BR-003 | ワイルドカード対応 | Database, Sequence, Schemaパラメータでワイルドカード使用可能 | NonPipelineセット |

### 計算ロジック

- 完全修飾シーケンス名: `$sequenceItem.Schema + "." + $sequenceItem.Name`

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| シーケンス削除 | sys.sequences | DELETE | シーケンスメタデータ削除 |

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

#### sys.sequences

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| DELETE | - | schema_id, name による特定 | SMO Drop()メソッドで実行 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | Stop-Function | Drop()実行失敗 | 権限確認、依存オブジェクト確認 |

### リトライ仕様

リトライ機能なし（失敗時はStop-Functionで処理継続、IsRemoved=$false設定）

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

SMOのDrop()メソッドによる暗黙的トランザクション。失敗時は自動ロールバック。

## パフォーマンス要件

特に定義なし。通常のDDL操作として即時完了が期待される。

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

- DROP権限またはシーケンス所有権が必要
- SqlCredentialによる認証情報の安全な受け渡し
- ConfirmImpact='High'による誤削除防止

## 備考

- パイプラインからGet-DbaDbSequence出力を受け取り可能
- WhatIfおよびConfirmをサポート
- Out-GridView -PassThruとの連携で対話的選択削除が可能

---

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

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

### 推奨読解順序

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

出力オブジェクトの構造を理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Remove-DbaDbSequence.ps1 | `public/Remove-DbaDbSequence.ps1` | 125-135行目の出力PSCustomObject構造 |

**読解のコツ**: 出力オブジェクトにはComputerName, InstanceName, SqlInstance, Database, Sequence（完全修飾）, SequenceName, SequenceSchema, Status, IsRemovedプロパティがある。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Remove-DbaDbSequence.ps1 | `public/Remove-DbaDbSequence.ps1` | パラメータセットとCmdletBinding設定 |

**主要処理フロー**:
1. **87-104行目**: パラメータ定義（ParameterSetName: NonPipeline/Pipeline）
2. **106-108行目**: beginブロック - 空の配列初期化
3. **110-119行目**: processブロック - シーケンス収集
4. **121-148行目**: endブロック - 削除実行

#### Step 3: 各処理層を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Remove-DbaDbSequence.ps1 | `public/Remove-DbaDbSequence.ps1` | 削除ロジックの詳細 |

**主要処理フロー**:
- **111-115行目**: SqlInstance指定時のGet-DbaDbSequence呼び出し（WhatIf/Confirmを除外）
- **116-118行目**: パイプライン入力時のInputObject追加
- **122行目**: コメント - endブロック使用理由の説明
- **123-147行目**: シーケンス削除ループ
- **136-139行目**: Drop成功時の処理
- **140-144行目**: Drop失敗時のエラーハンドリング

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

```
Remove-DbaDbSequence
    │
    ├─ [begin]
    │      └─ $sequences = @() 初期化
    │
    ├─ [process]
    │      ├─ Get-DbaDbSequence (SqlInstance指定時)
    │      │      └─ パラメータ転送（WhatIf/Confirm除外）
    │      │
    │      └─ InputObject追加 (パイプライン入力時)
    │
    └─ [end]
           └─ foreach sequenceItem
                  ├─ ShouldProcess確認
                  ├─ Drop() メソッド実行
                  ├─ Get-ErrorMessage (失敗時)
                  └─ 結果出力
```

### データフロー図

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

SqlInstance/パラメータ ───▶ Get-DbaDbSequence ────────────▶ Sequence[]
        または                     │
InputObject (パイプライン) ────────┘
                                   │
                                   ▼
                            $sequences配列
                                   │
                                   ▼
                            foreach + Drop() ────────────▶ PSCustomObject
                                                          (Status, IsRemoved)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Remove-DbaDbSequence.ps1 | `public/Remove-DbaDbSequence.ps1` | ソース | メインコマンドレット |
| Get-DbaDbSequence.ps1 | `public/Get-DbaDbSequence.ps1` | ソース | シーケンス取得 |
