Module | Mongoid::Criterion::Exclusion |
In: |
lib/mongoid/criterion/exclusion.rb
|
This module contains criteria behaviour for exclusion of values.
Adds a criterion to the Criteria that specifies values that are not allowed to match any document in the database. The MongoDB conditional operator that will be used is "$ne".
@example Match documents without these values.
criteria.excludes(:field => "value1") criteria.excludes(:field1 => "value1", :field2 => "value1")
@param [ Hash ] attributes: A Hash where the key is the field
name and the value is a value that must not be equal to the corresponding field value in the database.
@return [ Criteria ] A newly cloned copy.
Adds a criterion to the Criteria that specifies values where none should match in order to return results. This is similar to an SQL "NOT IN" clause. The MongoDB conditional operator that will be used is "$nin".
@example Match documents with values not in the provided.
criteria.not_in(:field => ["value1", "value2"]) criteria.not_in(:field1 => ["value1", "value2"], :field2 => ["value1"])
@param [ Hash ] attributes A Hash where the key is the field name
and the value is an +Array+ of values that none can match.
@return [ Criteria ] A newly cloned copy.
Adds a criterion to the Criteria that specifies the fields that will get returned from the Document. Used mainly for list views that do not require all fields to be present. This is similar to SQL "SELECT" values.
@example Limit the fields to only the specified.
criteria.only(:field1, :field2, :field3)
@note only and without cannot be used together.
@param [ Array<Symbol> ] args A list of field names to limit to.
@return [ Criteria ] A newly cloned copy.
Adds a criterion to the Criteria that specifies the fields that will not get returned by the document.
@example Filter out specific fields.
criteria.without(:field2, :field2)
@note only and without cannot be used together.
@param [ Array<Symbol> args A list of fields to exclude.
@return [ Criteria ] A newly cloned copy.
@since 2.0.0