トランザクションを使用するバッチ変更

Overview

このガイドでは、EF Core Provider アプリケーションでトランザクションを使用する方法を学ぶことができます。トランザクションは一連の書き込み操作をラップします。トランザクション内の操作が 1 つでも失敗すると、プロバイダーはトランザクション内のすべての変更をロールバックします。この動作により、データの整合性が確保されます。

EF Core プロバイダーは次のトランザクション モードをサポートしています。

• 暗黙的なトランザクション: プロバイダーは、SaveChanges() メソッドと SaveChangesAsync() メソッドへの呼び出しを自動的にトランザクションでラップします。この動作を構成または無効にする方法については、暗黙的なトランザクションの構成を参照してください。

• 明示的なトランザクション: Database.BeginTransaction() メソッドを呼び出してトランザクションを手動で開始し、Commit() または Rollback() を呼び出してトランザクションをコミットまたはロールバックします。

public class Planet
{
    public ObjectId _id { get; set; }
    public string name { get; set; } = null!;
    public int orderFromSun { get; set; }
    public bool hasRings { get; set; }
}

要件と制限事項

トランザクションを使用する前に、以下の要件と制約事項に留意してください。

• トランザクションには、レプリカセットやシャーディングされたクラスターなどのマルチドキュメントトランザクションをサポートするMongoDB Server の配置が必要です。アプリケーションがスタンドアロン配置でトランザクションを開始しようとすると、プロバイダーは NotSupportedException をスローします。これを防ぐには、暗黙的トランザクションの構成に記述されているように AutoTransactionBehavior.Never を設定します。

• EF Core プロバイダーは、System.Transactions.TransactionScopeによって作成されるような .NET 環境トランザクションをサポートしません。環境トランザクションを使用しようとすると、プロバイダーは例外をスローします。代わりに暗黙的または明示的なトランザクションを使用します。

暗黙的なトランザクション

デフォルトで、EF Core プロバイダーは複数の ルート エンティティ が影響を受ける場合、SaveChanges() と SaveChangesAsync() の呼び出しを自動的にトランザクションでラップします。ルート エンティティは、コレクション内のトップレベル ドキュメントです。これは、別のドキュメント内に保存される所有型または埋め込み型とは対照的です。

次の例では、単一の SaveChanges() 呼び出しで 2 つの惑星を挿入しています。この操作は複数のルートエンティティに影響するため、プロバイダーは自動的にトランザクションでラップします。いずれかの挿入が失敗した場合、プロバイダーは両方の変更をロールバックします。

SynchronousAsynchronous対応するコードを表示するには、 タブまたは タブを選択します。

dbContext.Planets.AddRange(
    new Planet { Name = "Mercury" },
    new Planet { Name = "Venus" }
);
// Both inserts succeed or both are rolled back
dbContext.SaveChanges();

dbContext.Planets.AddRange(
    new Planet { Name = "Mercury" },
    new Planet { Name = "Venus" }
);
// Both inserts succeed or both are rolled back
await dbContext.SaveChangesAsync();

dbContext.Database.AutoTransactionBehavior = AutoTransactionBehavior.Never;
// This SaveChanges() call will not use a transaction
dbContext.Planets.Add(new Planet { Name = "Mars" });
dbContext.SaveChanges();

dbContext.Database.AutoTransactionBehavior = AutoTransactionBehavior.Never;
// This SaveChangesAsync() call will not use a transaction
dbContext.Planets.Add(new Planet { Name = "Mars" });
await dbContext.SaveChangesAsync();

明示的なトランザクション

明示的なトランザクションを使用して、複数の SaveChanges() 呼び出しとその他の操作を 1 つのアトミックな作業単位にグループ化できます。明示的なトランザクションを開始するには、Database.BeginTransaction() または Database.BeginTransactionAsync() メソッドを呼び出します。操作を実行した後、Commit() または CommitAsync() を呼び出してトランザクションを完了します。

次の例では、複数の操作を 1 つのトランザクションにまとめることで、このパターンを示しています。いずれかの操作で例外がスローされた場合、プロバイダーはトランザクション内のすべての変更を自動的にロールバックします。SynchronousAsynchronous対応するコードを表示するには、 タブまたは タブを選択します。

using var transaction = dbContext.Database.BeginTransaction();
var planet = dbContext.Planets.First(p => p.Name == "Mercury");
planet.Name = "Mercury (Updated)";
dbContext.SaveChanges();
dbContext.Planets.Add(new Planet { Name = "Venus" });
dbContext.SaveChanges();
transaction.Commit();

await using var transaction = await dbContext.Database.BeginTransactionAsync();
var planet = await dbContext.Planets.FirstAsync(p => p.Name == "Mercury");
planet.Name = "Mercury (Updated)";
await dbContext.SaveChangesAsync();
dbContext.Planets.Add(new Planet { Name = "Venus" });
await dbContext.SaveChangesAsync();
await transaction.CommitAsync();

var options = new TransactionOptions(
    readConcern: new Optional<ReadConcern>(ReadConcern.Majority)
);
using var transaction = dbContext.Database.BeginTransaction(options);
var planet = dbContext.Planets.First(p => p.Name == "Mercury");
planet.Name = "Mercury (Updated)";
dbContext.SaveChanges();
transaction.Commit();

var options = new TransactionOptions(
    readConcern: new Optional<ReadConcern>(ReadConcern.Majority)
);
await using var transaction = await dbContext.Database.BeginTransactionAsync(options);
var planet = await dbContext.Planets.FirstAsync(p => p.Name == "Mercury");
planet.Name = "Mercury (Updated)";
await dbContext.SaveChangesAsync();
await transaction.CommitAsync();

トランザクションの制限

トランザクションを使用する場合、次の制限と注意事項が適用されます。

• 自動トランザクションは、配置がサポートしていない場合にのみ無効にしてください。自動トランザクションを無効にすると、データの不整合が発生し、楽観的同時実行を使用できなくなります。

• MongoDB Server はネストされたトランザクションをサポートしません。トランザクションが既にアクティブな状態で BeginTransaction() または BeginTransactionAsync() を呼び出すと、プロバイダーは InvalidOperationException をスローします。

• MongoDB Server はトランザクションの保存ポイントをサポートしません。トランザクション全体をコミットまたはロールバックする必要があります。

• デフォルトでは、MongoDB Server は transactionLifetimeLimitSeconds サーバー パラメーターによって制御されるように、60 秒を超えて実行されるトランザクションを中止します。この制限は、暗黙的なトランザクションと明示的なトランザクションの両方に適用されます。トランザクションがこの時間制限を超えると、MongoDB Server はトランザクションを中止し、プロバイダーはエラーをスローします。外部 API 呼び出しなどの時間のかかる操作は、トランザクション内で行わないでください。

• MongoDB Server でネットワーク中断が発生した場合、またはレプリカセットの選挙を実行する必要がある場合、TransientTransactionError エラーが返される可能性があります。このような場合、EF Core Provider はトランザクションを自動的に再試行しません。一時的なトランザクション エラーと再試行戦略の詳細については、「トランザクション エラー処理」を参照してください。

詳細情報

このガイドの概念の詳細については、次のリソースを参照してください。

• MongoDB へのデータの書込み (write)
• 楽観的な同時実行性によるデータ整合性の確保
• トランザクション

このガイドで使用されているメソッドの詳細については、次の .NET API ドキュメントを参照してください。

• BeginTransaction() と BeginTransactionAsync()

• CommitTransaction() と CommitTransactionAsync()

• RollbackTransaction()とRollbackTransactionAsync()

• SaveChanges() と SaveChangesAsync()