クエリを指定する

サンプル データ

このガイドの例では、バンドまたはステージを表す Band モデルを使用します。 Band モデルの定義は、異なるクエリ機能を示すために、各セクションで異なる場合があります。 一部のセクションでは、クエリ機能を示すために他のモデルを使用する場合があります。

フィールド構文

フィールドクエリ構文では、基本的なRubyハッシュが使用されます。 キーはシンボルまたは string にすることができ、 MongoDBドキュメント内のフィールド名に対応します。

次のコードは、フィールドクエリ構文を使用して、nameフィールド値が 'Depeche Mode' であるドキュメントを検索する 2 つの同等のクエリを示しています。

Band.where(name: 'Depeche Mode')
Band.where('name' => 'Depeche Mode')

クエリAPIシンタックス

次の同等のクエリに示すように、 ハッシュ構文 を使用して任意のフィールドに Query API演算子を指定できます。

Band.where(founded: {'$gt' => 1980})
Band.where('founded' => {'$gt' => 1980})

シンボル演算子構文

次のコードに示すように、それぞれのフィールド名のシンボルのメソッドとしてクエリAPI演算子を指定できます。

Band.where(:founded.gt => 1980)

定義済みフィールド

フィールドをクエリするには、フィールドはモデルクラス定義内に含まれている必要はありません。 ただし、 モデルクラスでフィールドが定義されている場合、Mongoid はクエリを構築するときに、定義されたフィールド型と一致するようにクエリ値を強制します。

次のコードでは、foundedフィールドをクエリするときに string 値を指定します。 foundedフィールドはモデルクラスで Integer 値を持つように定義されているため、クエリを実行するときに Mongoid は string '2020' を 2020 に強制します。

Band.where(founded: '2020')

Mongoid でフィールドを定義する方法の詳細については、「 フィールド タイプガイド 」を参照してください。

Raw Values

Mongoid のクエリ型強制動作をバイパスし、データベース内の未加工の型の値を直接クエリするには、次のコードに示すように、クエリ値を Mongoid::RawValueクラスでラップします。

Band.where(founded: Mongoid::RawValue('2020'))

フィールド エイリアス

クエリは、モデルクラス定義で設定したストレージフィールド名とフィールドエイリアスに従います。

id フィールドと _id フィールドはエイリアスであるため、クエリではどちらのフィールド名を使用できます。

Band.where(id: '5ebdeddfe1b83265a376a760')
Band.where(_id: '5ebdeddfe1b83265a376a760')

埋め込みドキュメント

埋め込みドキュメントのフィールドの値をクエリするには、ドット表記 を使用できます。 次のコードは、埋め込み Managerドキュメントの nameフィールドが 'Smith' であるドキュメントを検索します。

Band.where('manager.name' => 'Smith')

次のコードは、埋め込みフィールドをクエリするときにシンボル演算子を使用する方法を示しています。

Band.where(:'manager.name'.ne => 'Smith')

演算子の組み合わせ

論理演算子は ActiveRecord の論理演算子と同じセマンティクスを持ちます。

次のコードのクエリに示すように、同じフィールドに条件が複数回指定されている場合、すべての条件が基準に追加されます。

# Combines as "and"
Band.where(name: 'Swans').where(name: 'Feist')
# Combines as "or"
Band.where(name: 'Swans').or(name: 'Feist')

any_of、none_of、nor、not の操作は同様に動作します。

and、or、nor 論理演算子を使用する場合、それらはその点までに構築された基準に基づいて動作します 。

# "or" applies to the first condition, and the second is combined
# as "and"
Band.or(name: 'Sun').where(label: 'Trust')
# Same as previous example - "where" and "and" are aliases
Band.or(name: 'Sun').and(label: 'Trust')
# Same operator can be stacked any number of times
Band.or(name: 'Sun').or(label: 'Trust')
# The last label condition is added to the top level as "and"
Band.where(name: 'Sun').or(label: 'Trust').where(label: 'Feist')
# Interpreted query:
# {"$or"=>[{"name"=>"Sun"}, {"label"=>"Trust"}], "label"=>"Feist"}

ではない動作

引数なしで not メソッドを使用できます。その場合、指定された次の条件は否定されます。 not メソッドは、1 つ以上のハッシュ条件または Criteria オブジェクトを使用して呼び出すことができます。これらはすべて否定されて条件に追加されます。

次の例えは not の動作を示しています。

# "not" negates "where"
Band.not.where(name: 'Best')
# The second "where" is added as "$and"
Band.not.where(name: 'Best').where(label: /Records/)
# "not" negates its argument
Band.not(name: 'Best')

# String negation - uses "$ne"
Band.not.where(name: 'Best')
 
# Regex negation - uses "$not"
Band.not.where(name: /Best/)

and と同様に、not操作は単純なフィールド基準の個々の条件を否定します。 複雑な条件の場合、およびフィールドにすでに条件が定義されている場合、Mongoid は {'$and' => [{'$nor' => ...}]} 構造を使用して $not をエミュレートします。これは、 MongoDB がグローバルではなくフィールドごとにのみ $not 演算子をサポートしているためです。

# Simple condition
Band.not(name: /Best/)
# Complex conditions
Band.where(name: /Best/).not(name: 'Astral Projection')
# Symbol operator syntax
Band.not(:name.ne => 'Astral Projection')

not配列または正規表現とともに$not を使用している場合は、サーバー マニュアルで の制限を参照してください。

合併戦略

Mongoid は、次のマージ戦略を提供します。

• オーバーライド : 新しい演算子インスタンスは、同じ演算子を使用して同じフィールドの既存の条件を置き換えます。

• 交差: 同じフィールドで同じ演算子を使用する条件が既に存在する場合、既存の条件の値と新しい条件の値が交差され、その結果が演算子値として保存されます。

• 結合: 同じフィールドで同じ演算子を使用する条件が既に存在する場合、新しい条件の値が既存の条件の値に追加され、結果が演算子値として保存されます。

次のコードは、in を例の演算子として使用して、マージ戦略が条件を生成する方法を示しています。

Band.in(name: ['a']).override.in(name: ['b'])
# Interpreted query:
# {"name"=>{"$in"=>["b"]}}
Band.in(name: ['a', 'b']).intersect.in(name: ['b', 'c'])
# Interpreted query:
# {"name"=>{"$in"=>["b"]}}
Band.in(name: ['a']).union.in(name: ['b'])
# Interpreted query:
# {"name"=>{"$in"=>["a", "b"]}}

この戦略は、Criteria インスタンスで override、intersect、または union を呼び出すことによってリクエストされます。リクエストされた戦略は、クエリで呼び出される次の条件メソッドに適用されます。次に呼び出される条件メソッドがマージ戦略をサポートしていない場合、次の例に示すように、戦略はリセットされます。

Band.in(name: ['a']).union.ne(name: 'c').in(name: ['b'])
# Interpreted query:
# {"name"=>{"$in"=>["a"], "$ne"=>"c"}, "$and"=>[{"name"=>{"$in"=>["b"]}}]}

ne はマージ戦略をサポートしていないため、union 戦略は無視され、リセットされます。 次に、in が 2 回目に呼び出されるときに、アクティブな戦略がありません。

サポートされている演算子メソッド

次の演算子メソッドはマージ戦略をサポートします。

• all

• in

• nin

このメソッドのセットは、Mongoid の将来のリリースで拡張される可能性があります。 将来の互換性を確保するためには、次のメソッド呼び出しがマージ戦略をサポートする演算子である場合にのみ、戦略メソッドを呼び出します。

マージ戦略は、指定されたメソッドを通じて条件が追加された場合にのみ適用されます。 次の例では、2 つ目の条件が in ではなく where として追加されているため、マージ戦略は適用されません。

Band.in(name: ['a']).union.where(name: {'$in' => 'b'})
# Interpreted query:
# {"foo"=>{"$in"=>["a"]}, "$and"=>[{"foo"=>{"$in"=>"b"}}]}

演算子値の拡張

マージ戦略をサポートする演算子メソッドは、値の型として Array を受け取ります。 Mongoid は、これらの演算子メソッドで使用される場合、Range などの Array 互換型を拡張します。

次の例では、 in メソッドを使用するときにクエリ値として Rangeオブジェクトを渡す方法を示しています。

Band.in(year: 1950..1960)
# Interpreted query:
# {"year"=>{"$in"=>[1950, 1951, 1952, 1953, 1954, 1955, 1956, 1957, 1958, 1959, 1960]}}

Mongoid は、次の例に示すように、Array 以外の値を配列でラップします。

Band.in(year: 1950)
# Interpreted query: {"year"=>{"$in"=>[1950]}}

関連付け

埋め込み関連付けを一致させるには、elem_match メソッドを使用します。

この例では、 Band と Tour の間の埋め込み関連付けを定義する次のモデルを使用します。

class Band
    include Mongoid::Document
    field :name, type: String
    embeds_many :tours
end
class Tour
  include Mongoid::Document
  field :city, type: String
  field :year, type: Integer
  embedded_in :band
end

次のコードでは、Bandオブジェクトと埋め込み Tour オブジェクトを作成し、elem_match メソッドを使用して cityフィールドをクエリします。

aerosmith = Band.create!(name: 'Aerosmith')
Tour.create!(band: aerosmith, city: 'London', year: 1995)
Tour.create!(band: aerosmith, city: 'New York', year: 1999)
# Returns the "Aerosmith" document
Band.elem_match(tours: {city: 'London'})

次の例に示すように、elem_match を使用して再帰的に埋め込まれた関連付けをクエリできます。

class Tag
    include Mongoid::Document
    field name:, type: String
    recursively_embeds_many
end
# Creates the root Tag
root = Tag.create!(name: 'root')
# Adds embedded Tags
sub1 = Tag.new(name: 'sub_tag_1', child_tags: [Tag.new(name: 'sub_sub_tag_1')])
root.child_tags << sub1
root.child_tags << Tag.new(name: 'sub_tag_2')
root.save!
# Searches for Tag in which one child Tag tame is "sub_tag_1"
Tag.elem_match(child_tags: {name: 'sub_tag_1'})
# Searches for a child Tag in which one child Tag tame is "sub_sub_tag_1"
root.child_tags.elem_match(child_tags: {name: 'sub_sub_tag_1'})

関連付けについて詳しくは、「 関連付けガイド 」を参照してください。

ドキュメントをカウント

コレクション内のドキュメントの数をカウントするには、count メソッドと estimated_count メソッドを使用します。

count メソッドを使用して、フィルタ条件に一致するドキュメントの数をカウントできます。

# Counts all documents in collection
Band.count
# Counts documents that match criteria
Band.where(country: 'England').count

estimated_count メソッドを使用して、コレクションメタデータからコレクション内のドキュメントのおおよその数を取得できます。

Band.estimated_count

estimated_countメソッドは、モデルのスコープによって設定された条件を含む、クエリ条件を受け入れません。デフォルトのスコープを持つモデルでこのメソッドを呼び出す場合は、まず unscoped メソッドを呼び出してスコープを無効にする必要があります。

一般的なメソッド

次のリストで説明されているメソッドを使用すると、位置に基づいて返されたドキュメントのリストから特定の結果を選択できます。

• first: 最初に一致するドキュメントを返します。 整数値のパラメータを渡すことで、最初の n ドキュメントを取得できます。 このメソッドは、_idフィールドでのソートを自動的に使用します。 例については、次のコードの ～ 行を参照してください。18

• last: 最後に一致したドキュメントを返します。 整数値のパラメータを渡すことで、最後の n ドキュメントを取得できます。 このメソッドは、_idフィールドでのソートを自動的に使用します。 11の例については、次のコードの 行を参照してください。

• first_or_create: 最初に一致するドキュメントを返します。 一致するドキュメントがない場合、 は新しく保存されたドキュメントを作成して返します。

• first_or_initialize: 最初に一致するドキュメントを返します。 一致するドキュメントがない場合は、新しいドキュメントを返します。

• second: 2 番目に一致するドキュメントを返します。 _idフィールドでのソートを自動的に使用します。

• third: 3 番目に一致するドキュメントを返します。 _idフィールドでのソートを自動的に使用します。

• fourth: 一致する 4 番目のドキュメントを返します。 _idフィールドでのソートを自動的に使用します。

• fifth: 一致する 5 番目のドキュメントを返します。 _idフィールドでのソートを自動的に使用します。

• second_to_last: 最後から 2 番目に一致するドキュメントを返します。 _idフィールドでのソートを自動的に使用します。 14の例については、次のコードの 行を参照してください。

• third_to_last: 最後から 3 番目に一致するドキュメントを返します。 _idフィールドでのソートを自動的に使用します。

次のコードは、前述のリストで説明されているいくつかのメソッドを使用する方法を示しています。

1
# Returns the first document in the collection
2
Band.first
3
4
# Returns the first matching document
5
Band.where(founded: {'$gt' => 1980}).first
6
7
# Returns the first two matching documents
8
Band.first(2)
9
10
# Returns the last matching document
11
Band.where(founded: {'$gt' => 1980}).last
12
13
# Returns the second to last document
14
Band.second_to_last

フィールド値を調査

コレクション内のドキュメントの指定されたフィールドの値を検査するには、次のメソッドを使用できます。

• distinct: 単一のフィールドの個別の値のリストを取得します。 例については、次のコードの - 行を参照してください。17

• pick: 指定されたフィールドの値を 1 つのドキュメントから取得します。 設定されていないフィールドおよび存在しないフィールドの場合は nil を返します。 10の例については、次のコードの 行を参照してください。

• pluck: 指定されたフィールドのすべての値を取得します。 設定されていないフィールドおよび存在しないフィールドの場合は nil を返します。 13の例については、次のコードの 行を参照してください。

• tally: 指定されたフィールドの値とカウントのマッピングを取得します。 16の例については、次のコードの 行を参照してください。

上記のメソッドはドット表記を使用して参照されるフィールド名を受け入れます。これにより、埋め込まれた関連付け内のフィールドを参照できます。 また、埋め込みドキュメントで定義されているフィールドエイリアス も尊重します。

次のコードは、これらのメソッドの使用方法を示しています。

1
Band.distinct(:name)
2
# Example output: "Ghost Mountain" "Hello Goodbye" "She Said"
3
4
Band.where(:members.gt => 2).distinct(:name)
5
# Example output: "Arctic Monkeys" "The Smiths"
6
7
Band.distinct('tours.city')
8
# Example output: "London" "Sydney" "Amsterdam"
9
10
Band.all.pick(:name)
11
# Example output: "The Smiths"
12
13
Band.all.pluck(:country)
14
# Example output: "England" "Spain" "England" "Japan"
15
16
Band.all.tally(:country)
17
# Example output: ["England",2] ["Italy",3]

その他

次のリストでは、別のカテゴリに分類されない Mongoid メソッドを説明します。

• each: 一致するすべてのドキュメントを反復処理します。

# Print each matching document "name" to console
Band.where(:members.gt => 1).each do |band|
  p band.name
end

• exists?: 一致するドキュメントが存在するかどうかを判断し、一致するドキュメントが少なくとも 1 つ見つかった場合は true を返します。

# Checks existence of any document
Band.exists?
# Checks existence based on query
Band.where(name: "Le Tigre").exists?
Band.exists?(name: "Le Tigre")
# Checks existence based on "_id" value
Band.exists?('6320d96a3282a48cfce9e72c')
# Always returns false
Band.exists?(false)
Band.exists?(nil)