トランザクションとセッション

Overview

このガイドでは、Mongoid を使用して トランザクション を実行する方法を学習できます。トランザクションを使用すると、トランザクション全体がコミットされた場合にのみ、データを変更する一連の操作を実行できます。 トランザクション内のいずれかの操作が成功しない場合、ドライバーはトランザクションを停止し、変更が反映される前にすべてのデータ変更を破棄します。 この特徴は アトミック性と呼ばれます。

MongoDBでは、トランザクションは論理 セッション 内で実行されます。セッションは 、順番に実行されるよう関連付けられた読み取り操作または書き込み操作のグループです。 セッションにより、一連の操作に対する因果整合性が有効になります。つまり、アプリケーション内のすべてのプロセスが因果関連の操作の順序に一致することを意味します。

セッションを使用すると、 ACID準拠のトランザクションで操作を実行でき、アトミック性、整合性、分離、耐久性を確保できます。MongoDBは、トランザクション操作で予期せぬエラーが発生した場合でも、その操作に関わるデータの一貫性が保たれることを保証します。

Mongoid では、次のいずれかの API を使用してトランザクションを実行できます。

• 高レベル トランザクションAPI : Mongoid がトランザクションのライフサイクルを管理します。このAPI はMongoid v9.0 以降で使用できます。

• 低レベルトランザクションAPI : トランザクションのライフサイクルを管理する必要があります。このAPI はMongoid v6.4 以降で使用できます。

セッションAPIセクションでは、トランザクションを実行せずにセッション内からデータに変更を加える方法について説明します。

高レベル トランザクションAPI

ハイレベルトランザクションAPI を使用して、トランザクションのライフサイクルを内部的に管理できます。 このAPI は、トランザクションをコミットまたは終了し、エラー処理ロジックを組み込んでいます。

トランザクションを開始するには、モデルのインスタンス、 モデルクラス、または Mongoid モジュールで transaction メソッドを呼び出します。

transaction メソッドを呼び出すと、Mongoid は次のタスクを実行します。

1. クライアントにセッションを作成します。

2. セッションでトランザクションを開始します。

3. 指定されたデータ変更を実行します。

4. エラーが発生しない場合はトランザクションをデータベースにコミットし、エラーが発生した場合はトランザクションを終了します。

5. セッションを閉じます。

トランザクションがコミットされる場合、Mongoid はトランザクション内で変更されたすべてのオブジェクトに対して任意の after_commit コールバックを呼び出します。 エラーが発生し、トランザクションがロールバックされた場合、Mongoid はトランザクション内で変更されたすべてのオブジェクトに対して任意の after_rollback コールバックを呼び出します。 これらのコールバックとその動作の詳細については、このガイドの「 コールバック 」セクションを参照してください。

class Book
  include Mongoid::Document
  field :title, type: String
  field :author, type: String
  field :length, type: Integer
end
class Film
  include Mongoid::Document
  field :title, type: String
  field :year, type: Integer
end

# Starts a transaction from the model class
Book.transaction do
  # Saves new Book and Film instances to MongoDB
  Book.create(title: 'Covert Joy', author: 'Clarice Lispector')
  Film.create(title: 'Nostalgia', year: 1983)
end
# Starts a transaction from an instance of Book
book = Book.create(title: 'Sula', author: 'Toni Morrison')
book.transaction do
  # Saves a new field value to the Book instance
  book.length = 192
  book.save!
end
# Starts a transaction from the Mongoid instance
Mongoid.transaction do
  # Deletes the Book instance in MongoDB
  book.destroy
end

# Defines a class by using the :default client
class Post
  include Mongoid::Document
end
  
# Defines a class by using the :encrypted_client
class User
  include Mongoid::Document
  store_in client: :encrypted_client
end
# Starts a transaction on the :encrypted_client
User.transaction do
  # Uses the same client, so the operation is in the transaction
  User.create!
  # Uses a different client, so it is *not* in the transaction
  Post.create!
end

低レベル トランザクションAPI

低レベルAPIを使用する場合は、トランザクションを開始する前にセッションを作成する必要があります。 モデルクラスまたはモデルのインスタンスで with_session メソッドを呼び出すことで、セッションを作成できます。

その後、セッションで start_transaction メソッドを呼び出すことでトランザクションを開始できます。 このAPI を使用する場合は、トランザクションを手動でコミットまたは終了する必要があります。 セッションインスタンスで commit_transaction メソッドと abort_transaction メソッドを使用して、トランザクション ライフサイクルを管理できます。

# Starts a session from the model class
Book.with_session do |session|
  session.start_transaction 
  # Creates a Book
  Book.create(title: 'Siddhartha', author: 'Hermann Hesse')
  # Commits the transaction
  session.commit_transaction
rescue StandardError
  # Ends the transaction if there is an error
  session.abort_transaction
end

begin
  session.commit_transaction
rescue Mongo::Error => e
  if e.label?(Mongo::Error::UNKNOWN_TRANSACTION_COMMIT_RESULT_LABEL)
    retry
  else
    raise
  end
end

session.start_transaction(
    read_concern: {level: :majority},
    write_concern: {w: 3},
    read: {mode: :primary}
)

# Specifies that the operation should use the "other" client instead of
# the default client
User.with(client: :other) do
  Post.with(client: :other) do
    Post.with_session do |session|
      session.start_transaction
      Post.create!
      Post.create!
      User.create!
      session.commit_transaction
    end
  end
end

Session API

Mongoid では、トランザクションを実行するのと同様にセッションを使用できます。 モデルクラスまたはモデルのインスタンスで with_session メソッドを呼び出し、ブロック内で一部の操作を実行できます。 ブロック内のすべての操作は単一のセッションのコンテキストで実行されます。

セッションを使用する場合、次の制限が適用されます。

• スレッド間でセッションを共有することはできません。 セッションはスレッドセーフではありません。

• セッションをネストすることはできません。 例、別のモデルクラスの with_session メソッドに渡されるブロック内のモデルクラスで with_session メソッドを呼び出すことはできません。 次のコードは、エラーが発生するネストされたセッションを示しています。

  Book.with_session(causal_consistency: true) do
    # Nesting sessions results in errors
    Film.with_session(causal_consistency: true) do
      ...
    end
  end

• セッション ブロック内で使用されるすべてのモデル クラスと インスタンスは、同じ ドライバークライアントを使用する必要があります。 例、ブロックで使用されるモデルに、with_session を呼び出したモデルまたはインスタンスとは異なるクライアントを指定すると、Mongoid はエラーを返します。

Book.with_session(causal_consistency: true) do
  Book.create!
  book = Person.first
  book.title = "Swann's Way"
  book.save
end

book = Book.new
book.with_session(causal_consistency: true) do
  book.title = 'Catch-22'
  book.save
  book.sellers << Shop.create!
end

詳細情報

トランザクションの詳細については、サーバー マニュアルの「 トランザクション 」を参照してください。

CRUD操作の実行の詳細については、 「データ操作の実行」ガイドを参照してください。