# 機能設計書 378-Remove-DbaDbPartitionFunction

## 概要

本ドキュメントは、dbatools PowerShellモジュールのRemove-DbaDbPartitionFunctionコマンドの機能設計を定義する。このコマンドはSQL Serverデータベースから不要なパーティション関数を削除し、パーティション構成のクリーンアップを支援する機能を提供する。

### 本機能の処理概要

**業務上の目的・背景**：データベースのライフサイクル管理において、使用されなくなったパーティション関数の削除は、スキーマの整理とメンテナンス性の向上に重要である。パーティション化されたテーブルの廃止、スキーママイグレーション、パーティション戦略の見直しなどの際に、関連するパーティション関数を適切にクリーンアップする必要がある。

**機能の利用シーン**：
- パーティション化されたテーブル廃止後のクリーンアップ
- スキーママイグレーション時の不要オブジェクト削除
- パーティション戦略の変更時の古い関数削除
- データベース整理・最適化作業

**主要な処理内容**：
1. 対象パーティション関数の特定（Get-DbaDbPartitionFunction経由またはパイプライン入力）
2. ShouldProcessによる確認
3. SMO Drop()メソッドによる削除実行
4. 削除結果の出力

**関連システム・外部連携**：
- SQL Server（SMO経由での接続）
- Get-DbaDbPartitionFunction（パーティション関数取得）

**権限による制御**：対象データベースでのパーティション関数削除権限（通常はdb_owner以上）が必要。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | コマンドライン/PowerShell | 主画面 | コマンド実行とパラメータ指定 |

## 機能種別

データ削除 / CRUD操作（削除）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | No | 対象SQL Serverインスタンス | - |
| SqlCredential | PSCredential | No | SQL Server接続用の代替資格情報 | - |
| Database | string[] | No | 対象データベース | ワイルドカード対応 |
| ExcludeDatabase | object[] | No | 除外するデータベース | - |
| InputObject | Microsoft.SqlServer.Management.Smo.PartitionFunction[] | Yes (Pipeline) | Get-DbaDbPartitionFunctionからの入力 | - |
| EnableException | switch | No | 例外処理の有効化 | - |
| WhatIf | switch | No | 実行せずに動作確認 | - |
| Confirm | switch | No | 確認プロンプトの表示（ConfirmImpact=High） | - |

### 入力データソース

- SqlInstanceパラメータ: ユーザー指定
- InputObject: Get-DbaDbPartitionFunctionからのパイプライン入力

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | SQL Serverのコンピュータ名 |
| InstanceName | string | SQL Serverインスタンス名 |
| SqlInstance | string | 完全なSQL Serverインスタンス名 |
| Database | string | パーティション関数を含むデータベース名 |
| PartitionFunctionName | string | 削除されたパーティション関数の名前 |
| Status | string | 削除操作の結果（"Dropped"または エラーメッセージ） |
| IsRemoved | bool | 削除成功を示すブール値 |

### 出力先

PowerShellパイプライン（PSCustomObject）

## 処理フロー

### 処理シーケンス

```
1. Begin ブロック: 変数初期化
   └─ $partfuns配列の初期化

2. Process ブロック: パーティション関数の収集
   └─ SqlInstance指定時
      └─ Get-DbaDbPartitionFunctionで関数取得
   └─ パイプライン入力時
      └─ InputObjectを配列に追加

3. End ブロック: 削除実行
   └─ 各パーティション関数に対する処理
      └─ ShouldProcessによる確認
      └─ Drop()メソッド実行
      └─ 結果オブジェクトの出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{SqlInstance指定?}
    B -->|Yes| C[Get-DbaDbPartitionFunction呼び出し]
    B -->|No| D{InputObject指定?}
    C --> E[$partfunsに追加]
    D -->|Yes| F[InputObjectを$partfunsに追加]
    D -->|No| G[処理なし]
    E --> H[Endブロック: 削除ループ開始]
    F --> H
    G --> H
    H --> I{次の関数あり?}
    I -->|No| J[終了]
    I -->|Yes| K[ShouldProcess確認]
    K --> L{確認OK?}
    L -->|No| M[次の関数へ]
    L -->|Yes| N[出力オブジェクト初期化]
    N --> O[Drop()実行]
    O --> P{成功?}
    P -->|Yes| Q[Status="Dropped", IsRemoved=true]
    P -->|No| R[Stop-Function, Status=エラー]
    Q --> S[結果出力]
    R --> S
    S --> M
    M --> I
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | 確認プロンプト | ConfirmImpact=Highにより、デフォルトで削除確認を要求 | Confirm:$false未指定時 |
| BR-002 | Endブロック削除 | パイプライン処理時のコレクション変更エラーを防ぐため、Endブロックで削除実行 | 常に |
| BR-003 | 依存関係確認 | パーティションスキームが使用中の場合は削除失敗 | 依存関係あり時 |

### 計算ロジック

特になし

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| パーティション関数削除 | sys.partition_functions | DELETE（SMO経由） | パーティション関数の削除 |

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

#### sys.partition_functions

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| DELETE | - | 指定されたパーティション関数 | Drop()メソッド経由 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | DropError | Drop()実行失敗（依存関係等） | Stop-Functionで継続、エラーメッセージをStatusに設定 |

### リトライ仕様

リトライ機構は実装されていない。

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

各Drop()操作はSQL Serverのトランザクションとして実行される。

## パフォーマンス要件

- SMO Drop()操作の性能に依存
- 複数関数処理: 順次処理（並列処理なし）

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

- SqlCredentialパラメータによる代替資格情報のサポート
- ShouldProcess/Confirmによる誤操作防止
- db_owner以上の権限が推奨

## 備考

- パーティションスキームが使用している場合は削除できない（先にスキームを削除）
- Get-DbaDbPartitionFunctionからのパイプライン入力を推奨

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Remove-DbaDbPartitionFunction.ps1 | `public/Remove-DbaDbPartitionFunction.ps1` | **110-118行目**: 出力PSCustomObjectの構造定義 |

**読解のコツ**: 出力オブジェクトは削除前に初期化され、Status/IsRemovedはtry-catchの結果に基づいて設定される。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Remove-DbaDbPartitionFunction.ps1 | `public/Remove-DbaDbPartitionFunction.ps1` | **79-89行目**: パラメータ定義 |

**主要処理フロー**:
1. **79行目**: CmdletBinding属性でShouldProcess、ConfirmImpact=Highを設定
2. **81行目**: SqlInstanceパラメータ（オプション）
3. **85-86行目**: InputObjectパラメータ（Pipeline、PartitionFunction型）
4. **87-88行目**: EnableExceptionパラメータ

#### Step 3: Processブロック - パーティション関数収集

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Remove-DbaDbPartitionFunction.ps1 | `public/Remove-DbaDbPartitionFunction.ps1` | **95-104行目**: 関数収集処理 |

**主要処理フロー**:
- **96-100行目**: SqlInstance指定時のGet-DbaDbPartitionFunction呼び出し
- **101-103行目**: InputObject使用時の配列追加

#### Step 4: Endブロック - 削除実行

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | Remove-DbaDbPartitionFunction.ps1 | `public/Remove-DbaDbPartitionFunction.ps1` | **106-131行目**: 削除処理 |

**主要処理フロー**:
- **107行目**: コメント: コレクション変更エラー防止のためEndブロックで削除
- **108行目**: foreachループ開始
- **109行目**: ShouldProcess確認
- **110-118行目**: 出力オブジェクト初期化
- **119-122行目**: Drop()実行と成功時設定
- **123-127行目**: 失敗時のStop-Functionとエラー設定

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

```
Remove-DbaDbPartitionFunction
    │
    ├─ [SqlInstance指定時]
    │      └─ Get-DbaDbPartitionFunction
    │             └─ パーティション関数取得
    │
    ├─ ShouldProcess (Confirmプロンプト)
    │
    ├─ PartitionFunction.Drop()
    │      └─ SMO経由での削除実行
    │
    └─ Get-ErrorMessage (エラー時)
           └─ エラーメッセージ取得
```

### データフロー図

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

SqlInstance/InputObject ──▶ Get-DbaDbPartitionFunction
                           (SqlInstance時)
                                   │
                                   ▼
                           $partfuns配列に収集
                                   │
                                   ▼
                           Endブロック: 各関数ループ
                                   │
                                   ▼
                           ShouldProcess確認
                                   │
                                   ▼
                           Drop()実行 ─────────────────▶ PSCustomObject出力
                                                        (Status, IsRemoved)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Remove-DbaDbPartitionFunction.ps1 | `public/Remove-DbaDbPartitionFunction.ps1` | ソース | メイン機能実装 |
| Get-DbaDbPartitionFunction.ps1 | `public/Get-DbaDbPartitionFunction.ps1` | ソース | パーティション関数取得の依存関数 |
