クエリ結果の変更

サンプル データ

このガイドの例では、バンドまたはステージを表す Band モデルを使用します。 Band モデルの定義は、異なるクエリ機能を示すために、各セクションで異なる場合があります。 一部のセクションでは、特定のバンドを管理するユーザーを表す Manager モデルや、特定のバンドによるライブ パフォーマンスを表す Tour モデルも使用します。

含めるフィールドの指定

only メソッドは、データベースから指定されたフィールドのみを検索します。

次のコードでは、membersフィールドの値が 4 であるドキュメントから nameフィールドのみが返されます。

Band.where(members: 4).only(:name)

ロードされていない属性を参照しようとすると、Mongoid は Mongoid::Errors::AttributeNotLoaded エラーを発生させます。

また、 only メソッドを使用して、埋め込みドキュメントのフィールドを含めることもできます。

Band モデルには複数の Tour オブジェクトが埋め込まれている ことを考えてみましょう。 次のコードに示すように、year などの Tour モデルからフィールドをプロジェクトできます。

bands = Band.only(:name, 'tours.year')

次に、返されたドキュメントから埋め込みフィールドにアクセスできます。

# Returns the first Tour object from
# the first Band in the results
bands.first.tours.first

参照された関連付けのフィールドを only メソッドに渡すことはできますが、埋め込みオブジェクトをロードするときにプロジェクションは無視されます。 Mongoid は、参照先の関連付けのすべてのフィールドをロードします。 例、前述のコードに示すように、埋め込み Tourオブジェクトにアクセスすると、Mongoid は yearフィールドだけでなく、完全なオブジェクトを返します。

ドキュメントに has_one または has_and_belongs_to_many の関連付けが含まれており、only メソッドを呼び出すときに Mongoid がそれらの関連付けをロードする場合は、属性のリストに外部キーを持つフィールドを含める必要があります。

次の例では、Band モデルと Manager モデルに has_and_belongs_to_many の関連付けがあります。

class Band
  include Mongoid::Document
  field :name, type: String
  has_and_belongs_to_many :managers
end
class Manager
  include Mongoid::Document
  has_and_belongs_to_many :bands
end

次のコードは、manager_idsフィールドを含める場合に Mongoid が関連する Manager オブジェクトをロードする方法を示しています。

# Returns null
Band.where(name: 'Astral Projection').only(:name).first.managers
# Returns the first Manager object
Band.where(name: 'Astral Projection').only(:name, :manager_ids).first.managers

フィールドの除外

without メソッドを使用して、結果からフィールドを明示的に除外できます。

次のコードでは、返される Band オブジェクトから yearフィールドが除外されます。

Band.where(members: 4).without(:year)

結果数の制限

Mongoid が返す結果の数を制限するには、limit メソッドを使用します。

次のコードは、最大 5 ドキュメントを検索します。

Band.limit(5)

Band.take(5)

結果をスキップする

skip メソッドまたはそのエイリアス offset を使用すると、指定した数の結果をスキップできます。

skip への limit 呼び出しを連鎖させると、次の例に示すように、ドキュメントがスキップされた後に制限が適用されます。

Band.skip(2).limit(5)
# Skips the first two results and returns
# the following five results

次のコードは、結果を返すときに最初の 3 ドキュメントをスキップします。

Band.skip(3)
# Equivalent
Band.offset(3)

結果のバッチの生成

大規模なクエリを実行する場合、およびCriteria#each などの列挙メソッドを使用してクエリ結果を反復処理する場合、Mongoid は自動的にMongoDB getMore コマンド を使用して結果をバッチで読み込みます。デフォルトのバッチするサイズは 1000 ですが、batch_size メソッドを使用して別の値を設定できます。

次のコードを使用することで、バッチするサイズが 500 に設定されます。

Band.batch_size(500)

include メソッド

includes メソッドは、関連付けごとに個別のクエリを使用して関連付けを読み込みます。次のコードでは、バンドとそれに関連するデータベースとラベルを個別のクエリを使用して読み込みます。

Band.where(name: 'The Beatles').includes({ albums: :songs }, :labels).first

includes メソッドを使用すると、Mongoid は基本クラスに対してクエリを実行してすべての基本ドキュメントを取得し、その後に早期ロードする関連付けごとに個別のクエリを実行します。

前の例では、次のクエリが実行されます。

• Band ドキュメントを検索するための 1 回のクエリ

• 関連する Album ドキュメントを読み込む 1 つのクエリ

• 関連する Label ドキュメントを読み込む 1 つのクエリ

• 関連する Song ドキュメントを読み込む 1 つのクエリ

concern_load メソッド

eager_load メソッドは、 MongoDB集計パイプラインを$lookup 演算子とともに使用して、1 回のクエリですべての関連付けを読み込みます。次のコードでは、単一の集計パイプラインクエリを使用して、バンドとそれに関連するデータベースとラベルを読み込みます。関連付けごとに $lookup ステージが含まれます。

Band.where(name: 'The Beatles').eager_load({ albums: :songs }, :labels).first

パフォーマンスに関する考慮事項

includes メソッドと eager_load メソッドはどちらも早期読み込みを実行しますが、その方法は異なります。includes メソッドは基本ドキュメントに対して 1 つのクエリを実行し、その後 関連付けごとに個別のクエリを実行します。eager_load メソッドは、関連付けをロードするために、$lookup ステージを持つ単一の集計パイプラインを使用します。

eager_load メソッドは、includes よりもクエリを実行し、使用するメモリが少なくなります。ただし、メソッドの効率は、ドキュメント内の関連付けのタイプによって異なります。

• eager_load は、has_many、has_and_belongs_to_many、およびほとんどのデータセットで複数の関連付けの読み込みで高速です

• includes は、belongs_to、has_one、およびほとんどのデータセットでネストされた関連付けで高速です

ユースケースと関連付けのタイプに最適な方法を選択します。