最終更新：2025-03-30

概要#

Use-TransactionはPowerShellにおいて、開始済みのトランザクションスコープ内でスクリプトブロックを実行するためのコマンドレットである。トランザクションとは、一連の操作を単一の作業単位として処理するメカニズムであり、すべての操作が成功するか、またはすべての操作が失敗して元の状態に戻るかのいずれかを保証する。これはデータの整合性を維持するために重要な機能である。Use-Transactionを使用することで、トランザクション対応のリソースプロバイダー（例えばMicrosoft.PowerShell.Managementモジュールなど）に対する操作を、既存のトランザクション内で実行できる。

基本的な使い方#

トランザクションの開始と使用#

トランザクションを使用するには、まずStart-Transactionでトランザクションを開始し、その後Use-Transactionを使用してスクリプトブロックを実行する。

Start-Transaction
Use-Transaction -ScriptBlock {
    # トランザクション内で実行されるコマンド
    Set-Content -Path "C:\temp\test.txt" -Value "トランザクションテスト"
}
Complete-Transaction

ネストされたトランザクションの使用#

トランザクション内で別のトランザクションを開始することもできる。

Start-Transaction
Use-Transaction -ScriptBlock {
    # 外側のトランザクションで実行されるコマンド
    Start-Transaction
    Use-Transaction -ScriptBlock {
        # 内側のトランザクションで実行されるコマンド
    }
    Complete-Transaction
}
Complete-Transaction

トランザクションのロールバック#

エラーが発生した場合にトランザクションをロールバックすることができる。

Start-Transaction
try {
    Use-Transaction -ScriptBlock {
        # 問題がある可能性のあるコマンド
        Remove-Item -Path "C:\temp\important.txt"
    }
    Complete-Transaction
} catch {
    Write-Error "エラーが発生したためトランザクションをロールバックします: $_"
    Undo-Transaction
}

パラメータを使用したスクリプトブロックの実行#

パラメータを渡してトランザクション内でスクリプトブロックを実行することもできる。

Start-Transaction
$path = "C:\temp\test.txt"
$content = "動的に生成された内容"

Use-Transaction -ScriptBlock {
    param($filePath, $fileContent)
    Set-Content -Path $filePath -Value $fileContent
} -ArgumentList $path, $content

Complete-Transaction

応用的な使い方#

データベースライクな操作#

複数のファイル操作を一つのトランザクションとして扱う例である。

Start-Transaction
try {
    Use-Transaction -ScriptBlock {
        # 複数のファイル操作
        Set-Content -Path "C:\temp\config1.txt" -Value "設定1"
        Set-Content -Path "C:\temp\config2.txt" -Value "設定2"
        Set-Content -Path "C:\temp\config3.txt" -Value "設定3"
    }
    # すべての操作が成功した場合のみコミット
    Complete-Transaction
    Write-Host "すべての設定ファイルが正常に更新されました"
} catch {
    # エラーが発生した場合はロールバック
    Write-Error "ファイル更新中にエラーが発生しました: $_"
    Undo-Transaction
}

条件付きトランザクションのコミット#

特定の条件が満たされた場合にのみトランザクションをコミットする例である。

Start-Transaction
$success = $false

Use-Transaction -ScriptBlock {
    # トランザクション内の操作
    Set-Content -Path "C:\temp\data.txt" -Value "重要なデータ"
    
    # 操作の結果を検証
    $success = Test-Path -Path "C:\temp\data.txt"
}

if ($success) {
    Write-Host "検証に成功したためトランザクションをコミットします"
    Complete-Transaction
} else {
    Write-Host "検証に失敗したためトランザクションをロールバックします"
    Undo-Transaction
}

トランザクション内でのオブジェクト操作#

複数のオブジェクトの状態変更を一つのトランザクションで管理する例である。

Start-Transaction
$tempDir = "C:\temp\transaction_test"

try {
    Use-Transaction -ScriptBlock {
        # ディレクトリ作成
        New-Item -Path $tempDir -ItemType Directory -Force
        
        # 複数のファイル作成
        1..5 | ForEach-Object {
            New-Item -Path "$tempDir\file$_.txt" -ItemType File
            Set-Content -Path "$tempDir\file$_.txt" -Value "ファイル $_ の内容"
        }
    }
    
    # 条件チェック
    $fileCount = (Get-ChildItem -Path $tempDir).Count
    if ($fileCount -eq 5) {
        Write-Host "すべてのファイルが正常に作成されました"
        Complete-Transaction
    } else {
        Write-Host "一部のファイルが作成されませんでした"
        Undo-Transaction
    }
} catch {
    Write-Error "エラーが発生しました: $_"
    if ($null -ne (Get-Transaction)) {
        Undo-Transaction
    }
}

ハンズオン：Use-Transactionの実践#

以下はUse-Transactionコマンドを使用した実践例とその出力である。

1. 基本的なトランザクション処理

# テスト用のディレクトリを準備
$testDir = "C:\temp\transaction_test"
if (Test-Path $testDir) {
    Remove-Item -Path $testDir -Recurse -Force
}
New-Item -Path $testDir -ItemType Directory | Out-Null

# 基本的なトランザクションを実行
Start-Transaction
Write-Host "トランザクションを開始しました"

Use-Transaction -ScriptBlock {
    Set-Content -Path "$testDir\test1.txt" -Value "トランザクションテスト1"
    Write-Host "ファイル1を作成しました"
    
    Set-Content -Path "$testDir\test2.txt" -Value "トランザクションテスト2"
    Write-Host "ファイル2を作成しました"
}

# トランザクション内のファイルをチェック
Write-Host "トランザクション内でファイルを確認中..."
if (Test-Path "$testDir\test1.txt") {
    Write-Host "test1.txt が存在します"
} else {
    Write-Host "test1.txt が存在しません"
}

# トランザクションをコミット
Complete-Transaction
Write-Host "トランザクションをコミットしました"

# トランザクション完了後のファイルをチェック
Write-Host "トランザクション完了後にファイルを確認中..."
if (Test-Path "$testDir\test1.txt") {
    Write-Host "test1.txt が存在します"
    Get-Content "$testDir\test1.txt"
} else {
    Write-Host "test1.txt が存在しません"
}

出力例：

トランザクションを開始しました
ファイル1を作成しました
ファイル2を作成しました
トランザクション内でファイルを確認中...
test1.txt が存在します
トランザクションをコミットしました
トランザクション完了後にファイルを確認中...
test1.txt が存在します
トランザクションテスト1

2. トランザクションのロールバック

# トランザクションを開始してロールバックする例
Start-Transaction
Write-Host "トランザクションを開始しました"

Use-Transaction -ScriptBlock {
    Set-Content -Path "$testDir\rollback1.txt" -Value "ロールバックテスト1"
    Write-Host "rollback1.txt を作成しました"
    
    Set-Content -Path "$testDir\rollback2.txt" -Value "ロールバックテスト2"
    Write-Host "rollback2.txt を作成しました"
}

# ファイル確認
Write-Host "トランザクション内でのファイル確認:"
if (Test-Path "$testDir\rollback1.txt") {
    Write-Host "rollback1.txt が存在します"
} else {
    Write-Host "rollback1.txt が存在しません"
}

# トランザクションをロールバック
Undo-Transaction
Write-Host "トランザクションをロールバックしました"

# ロールバック後のファイル確認
Write-Host "ロールバック後のファイル確認:"
if (Test-Path "$testDir\rollback1.txt") {
    Write-Host "rollback1.txt が存在します"
} else {
    Write-Host "rollback1.txt が存在しません"
}

出力例：

トランザクションを開始しました
rollback1.txt を作成しました
rollback2.txt を作成しました
トランザクション内でのファイル確認:
rollback1.txt が存在します
トランザクションをロールバックしました
ロールバック後のファイル確認:
rollback1.txt が存在しません

3. エラーハンドリング付きトランザクション

# エラーハンドリングを含むトランザクション
Start-Transaction
Write-Host "エラーハンドリング付きトランザクションを開始しました"

try {
    Use-Transaction -ScriptBlock {
        Set-Content -Path "$testDir\error1.txt" -Value "エラー処理テスト1"
        Write-Host "error1.txt を作成しました"
        
        # 意図的にエラーを発生させる
        Write-Host "エラーを発生させます..."
        throw "意図的なエラー"
        
        # 以下は実行されない
        Set-Content -Path "$testDir\error2.txt" -Value "エラー処理テスト2"
        Write-Host "error2.txt を作成しました"
    }
    
    # エラーが発生した場合、ここには到達しない
    Complete-Transaction
    Write-Host "トランザクションをコミットしました"
} catch {
    Write-Host "エラーが発生しました: $_"
    if (Get-Transaction) {
        Undo-Transaction
        Write-Host "トランザクションをロールバックしました"
    }
}

# エラー後のファイル確認
Write-Host "エラー処理後のファイル確認:"
if (Test-Path "$testDir\error1.txt") {
    Write-Host "error1.txt が存在します"
} else {
    Write-Host "error1.txt が存在しません"
}

出力例：

エラーハンドリング付きトランザクションを開始しました
error1.txt を作成しました
エラーを発生させます...
エラーが発生しました: 意図的なエラー
トランザクションをロールバックしました
エラー処理後のファイル確認:
error1.txt が存在しません

4. パラメータを使用したトランザクション

# パラメータを渡すトランザクション
$fileName = "paramfile.txt"
$fileContent = "パラメータから渡された内容：" + (Get-Date)

Start-Transaction
Write-Host "パラメータを使用するトランザクションを開始しました"

Use-Transaction -ScriptBlock {
    param($name, $content)
    Set-Content -Path "$testDir\$name" -Value $content
    Write-Host "$name を作成しました"
} -ArgumentList $fileName, $fileContent

Complete-Transaction
Write-Host "トランザクションをコミットしました"

# ファイル内容の確認
Write-Host "作成されたファイルの内容:"
if (Test-Path "$testDir\$fileName") {
    Get-Content "$testDir\$fileName"
} else {
    Write-Host "$fileName が存在しません"
}

出力例：

パラメータを使用するトランザクションを開始しました
paramfile.txt を作成しました
トランザクションをコミットしました
作成されたファイルの内容:
パラメータから渡された内容：2025/03/30 2:25:32

5. トランザクションの状態確認

# トランザクション状態の確認
Start-Transaction
Write-Host "トランザクションを開始しました"

# トランザクションの状態を確認
$transaction = Get-Transaction
Write-Host "トランザクションの状態: $($transaction.Status)"
Write-Host "トランザクションID: $($transaction.TransactionId)"

# トランザクション内でコマンドを実行
Use-Transaction -ScriptBlock {
    Set-Content -Path "$testDir\status.txt" -Value "トランザクション状態テスト"
    Write-Host "status.txt を作成しました"
}

# 再度トランザクションの状態を確認
$transaction = Get-Transaction
Write-Host "操作後のトランザクション状態: $($transaction.Status)"

# トランザクションをコミット
Complete-Transaction
Write-Host "トランザクションをコミットしました"

出力例：

トランザクションを開始しました
トランザクションの状態: Active
トランザクションID: {71a5e88d-8c30-4f89-a684-60d5437cae26}
status.txt を作成しました
操作後のトランザクション状態: Active
トランザクションをコミットしました

6. クリーンアップ

# クリーンアップ処理
if (Test-Path $testDir) {
    Remove-Item -Path $testDir -Recurse -Force
    Write-Host "テスト用ディレクトリを削除しました"
}

出力例：

テスト用ディレクトリを削除しました

対応PowerShellバージョン#

Use-Transactionコマンドレットは以下のPowerShellバージョンで利用可能である：

• Windows PowerShell 2.0以降
• PowerShell Core 6.0以降は非対応（トランザクションコマンドレットはWindows PowerShellのみ）
• PowerShell 7.0以降も非対応

注意点：

• トランザクション機能をサポートしているリソースプロバイダー（Microsoft.PowerShell.Management, Microsoft.PowerShell.Utilityなど）との組み合わせでのみ使用可能
• リモートセッションではトランザクションがサポートされていない場合がある
• PowerShell Core 6.0以降ではトランザクション関連のコマンドレットが削除されているため注意が必要

参考サイト#

• Microsoft公式ドキュメント: Use-Transaction
• Microsoft公式ドキュメント: トランザクションについて
• PowerShell.org - Understanding PowerShell Transactions
• SS64.com PowerShell Commands - Use-Transaction