永続性設定

モデルレベルの永続性オプション

モデルクラス名の複数形とは異なる名前で、モデルのドキュメントをコレクションに保存するとします。 Mongoid がモデルのドキュメントを保存するコレクション、データベース、またはクライアントを変更するには、store_in コマンドを使用します。次の例は、 store_in マイクロを使用して、analytics という名前のクライアント内の otherデータベースに citizens というコレクションに Personクラスのドキュメントを保存する方法を示しています。

class Person
  include Mongoid::Document
  store_in collection: "citizens", database: "other", client: "analytics"
end

store_in マイクロは Lambda 関数を受け入れることもできます。これは、定数文字列を使用できない値を含む永続性コンテキストを定義する場合に役立ちます。

このパターンは、複数のユーザーがアプリケーションへの共通のアクセスを共有する マルチテナントアプリケーションで使用することができます。ラムダを使用すると、現在のスレッドに対してローカルの情報に基づいて永続性コンテキストを定義し、ユーザーがお互いのデータにアクセスできないようにすることができます。

次の例では、スレッド ローカル変数によって決定されたデータベースにドキュメントを保存します。

class Band
  include Mongoid::Document
  store_in database: ->{ Thread.current[:database] }
end

ランタイム永続化オプション

モデルクラスまたはインスタンスの with メソッドを使用して、実行時に操作のグループのモデルの永続構成を変更できます。

モデルクラスまたはインスタンスで with メソッドを呼び出し、永続性コンテキストを定義するオプションを渡します。 with メソッドは、次の 2 つの方法で呼び出すことができます。

• with(context, options): context は Mongoid::PersistenceContext のインスタンスであり、options はカスタマイズ可能なオプションのセットを表すハッシュです。

• with(options): options は、カスタマイズ可能なオプションのセットを表すハッシュです。

次に、 ブロックを使用して、指定されたコンテキストで実行する操作を定義します。定義するコンテキストは、ブロック内のコードの実行中にのみ存在します。

デフォルトでは 、Mongoid は bands と呼ばれるコレクションに Bandクラスのドキュメントを保存します。次のコード例では、 with メソッドを使用して、別のクライアント、データベース、コレクションを一時的に使用し、Band クラスのドキュメントで操作を実行します。

class Band
  include Mongoid::Document
  field :name, type: String
  field :likes, type: Integer
end
# Creates document in 'bands' collection in 'music-non-stop' database within
# default cluster
Band.with(database: "music-non-stop") do |band_class|
  band_class.create(name: "Medusa and the Polyps")
end
# Deletes all documents in 'artists' collection within default database
Band.with(collection: "artists") do |band_class|
  band_class.delete_all
end
band = Band.new(name: "Japanese Breakfast")
# Perform operations on tertiary cluster
band.with(client: :tertiary) do |band_object|
  band_object.save!
    
  band.save!
end

読み取り操作または書込み操作で with メソッド構成オプションを渡すこともできます。構成は、指定されたタイプの操作にのみ適用されます。

次の例では、 with メソッドを使用して、ブロック内のすべての読み取り操作にセカンダリノードを使用することを指定します。

Band.with(read: {mode: :secondary}) do
  Band.count
  # This write operation runs in the 
  # new persistence context, but is 
  # not affected by the read preference.
  Band.create(name: "Metallica")
end

class BandsController < ApplicationController
  before_action :switch_database
  after_action :reset_database
  private
  def switch_database
    I18n.locale = params[:locale] || I18n.default_locale
    Mongoid.override_database("my_db_name_#{I18n.locale}")
  end
  def reset_database
    Mongoid.override_database(nil)
  end
end

mongo_client.with

次のコード例では、 Band モデルクラスで使用されるクライアントにアクセスします。次に、クライアントの with メソッドを使用して musicデータベースに書き込み、w 書込みオプションを 0 に設定して書込み確認を要求しないようにします。

Band.mongo_client.with(write: { w: 0 }, database: "music") do |client|
  client[:artists].find(...)
end

collection.with

コレクションの :read オプションと :write オプションを上書きするには、 with メソッドを使用します。次の例は、 with メソッドを使用して w 書込みオプションを 0 に設定する方法を示しています。

Band.collection.with(write: { w: 0 }) do |collection|
  collection[:artists].find(...)
end