Module: Mongoid::Criteria::Findable

Included in:
Mongoid::Criteria
Defined in:
lib/mongoid/criteria/findable.rb

Overview

Mixin module included in Mongoid::Criteria which adds the ability to find document by id.

Instance Method Summary collapse

Instance Method Details

#execute_or_raise(ids, multi) ⇒ Document | Array<Document>

Execute the criteria or raise an error if no documents found.

Examples:

Execute or raise

criteria.execute_or_raise(id)

Parameters:

  • ids (Object) —

    The arguments passed.

  • multi (true | false) —

    Whether there arguments were a list, and therefore the return value should be an array.

Returns:

Raises:



23
24
25
26
27
 
# File 'lib/mongoid/criteria/findable.rb', line 23

def execute_or_raise(ids, multi)
  result = multiple_from_db(ids)
  check_for_missing_documents!(result, ids)
  multi ? result : result.first
end

#find(*args) ⇒ Document | Array<Document>

Note:

Each argument can be an individual id, an array of ids or a nested array. Each array will be flattened.

Find the matching document(s) in the criteria for the provided id(s).

Examples:

Find by an id.

criteria.find(BSON::ObjectId.new)

Find by multiple ids.

criteria.find([ BSON::ObjectId.new, BSON::ObjectId.new ])

Parameters:

  • *args ([ Object | Array<Object> ]...) —

    The id(s) to find.

Returns:



43
44
45
46
47
 
# File 'lib/mongoid/criteria/findable.rb', line 43

def find(*args)
  ids = prepare_ids_for_find(args)
  raise_invalid if ids.any?(&:nil?)
  for_ids(ids).execute_or_raise(ids, multi_args?(args))
end

#for_ids(ids) ⇒ Criteria

Adds a criterion to the Criteria that specifies an id that must be matched.

Examples:

Add a single id criteria.

criteria.for_ids([ 1 ])

Add multiple id criteria.

criteria.for_ids([ 1, 2 ])

Parameters:

  • ids (Array) —

    The array of ids.

Returns:



60
61
62
63
64
65
66
67
 
# File 'lib/mongoid/criteria/findable.rb', line 60

def for_ids(ids)
  ids = mongoize_ids(ids)
  if ids.size > 1
    send(id_finder, { _id: { "$in" => ids }})
  else
    send(id_finder, { _id: ids.first })
  end
end

#multiple_from_db(ids) ⇒ Array<Document>

Get the documents from the identity map, and if not found hit the database.

Examples:

Get the documents from the map or criteria.

criteria.multiple_from_map_or_db(ids)

Parameters:

  • ids (Array<Object>) —

    The searched ids.

Returns:

  • (Array<Document>) —

    The found documents.



78
79
80
81
82
 
# File 'lib/mongoid/criteria/findable.rb', line 78

def multiple_from_db(ids)
  return entries if embedded?
  ids = mongoize_ids(ids)
  ids.empty? ? [] : from_database(ids)
end